wxShapeFramework  1.13.0 beta
wxSFLayoutHorizontalTree Class Reference

Class encapsulating algorithm which layouts all top-most shapes into horizontal tree registered under "Horizontal Tree" name. More...

#include <AutoLayout.h>

Inheritance diagram for wxSFLayoutHorizontalTree:
Collaboration diagram for wxSFLayoutHorizontalTree:

Public Member Functions

 wxSFLayoutHorizontalTree ()
 Constructor. More...
 
virtual ~wxSFLayoutHorizontalTree ()
 Destructor. More...
 
virtual void DoLayout (ShapeList &shapes)
 Function performing the layout change. More...
 
void SetHSpace (double HSpace)
 Set horizontal space between shapes. More...
 
void SetVSpace (double VSpace)
 Set vertical space between shapes. More...
 
double GetHSpace () const
 Get horizontal space. More...
 
double GetVSpace () const
 Get vertical space. More...
 
- Public Member Functions inherited from wxSFLayoutAlgorithm
virtual ~wxSFLayoutAlgorithm ()
 Destructor. More...
 

Protected Member Functions

void ProcessNode (wxSFShapeBase *node, double x)
 
- Protected Member Functions inherited from wxSFLayoutAlgorithm
wxRect GetBoundingBox (const ShapeList &shapes)
 Calculate bounding box surroundig given shapes. More...
 
wxSize GetShapesExtent (const ShapeList &shapes)
 Get overall extent of all given shapes calculated as a sum of their width and height. More...
 
wxRealPoint GetShapesCenter (const ShapeList &shapes)
 Get center point of given shapes. More...
 
wxRealPoint GetTopLeft (const ShapeList &shapes)
 Get top-left point of bounding box surrounding given shapes. More...
 

Protected Attributes

double m_nMinY
 
int m_nCurrMaxHeight
 
double m_HSpace
 
double m_VSpace
 

Detailed Description

Class encapsulating algorithm which layouts all top-most shapes into horizontal tree registered under "Horizontal Tree" name.

Constructor & Destructor Documentation

◆ wxSFLayoutHorizontalTree()

wxSFLayoutHorizontalTree::wxSFLayoutHorizontalTree ( )
inline

Constructor.

◆ ~wxSFLayoutHorizontalTree()

virtual wxSFLayoutHorizontalTree::~wxSFLayoutHorizontalTree ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ DoLayout()

virtual void wxSFLayoutHorizontalTree::DoLayout ( ShapeList &  shapes)
virtual

Function performing the layout change.

Parameters
shapesList of shapes which should be layouted

Implements wxSFLayoutAlgorithm.

◆ GetHSpace()

double wxSFLayoutHorizontalTree::GetHSpace ( ) const
inline

Get horizontal space.

Returns
Horizontal space in pixels.

◆ GetVSpace()

double wxSFLayoutHorizontalTree::GetVSpace ( ) const
inline

Get vertical space.

Returns
Vertical space in pixels.

◆ ProcessNode()

void wxSFLayoutHorizontalTree::ProcessNode ( wxSFShapeBase node,
double  x 
)
protected

◆ SetHSpace()

void wxSFLayoutHorizontalTree::SetHSpace ( double  HSpace)
inline

Set horizontal space between shapes.

Parameters
HSpaceHorizontal space in pixels.

◆ SetVSpace()

void wxSFLayoutHorizontalTree::SetVSpace ( double  VSpace)
inline

Set vertical space between shapes.

Parameters
VSpaceVertical space in pixels.

Member Data Documentation

◆ m_HSpace

double wxSFLayoutHorizontalTree::m_HSpace
protected

◆ m_nCurrMaxHeight

int wxSFLayoutHorizontalTree::m_nCurrMaxHeight
protected

◆ m_nMinY

double wxSFLayoutHorizontalTree::m_nMinY
protected

◆ m_VSpace

double wxSFLayoutHorizontalTree::m_VSpace
protected

The documentation for this class was generated from the following file: