nux-0.9.46

nux::GridHLayout Class Reference

An horizontal grid layout. More...

#include <Nux/GridHLayout.h>

Inheritance diagram for nux::GridHLayout:
nux::Layout nux::Area nux::InitiallyUnownedObject nux::Focusable nux::Object nux::Trackable

Public Member Functions

 GridHLayout (NUX_FILE_LINE_PROTO)
 ~GridHLayout ()
virtual long ComputeLayout2 ()
virtual void GetCompositeList (std::list< Area * > *ViewList)
void EnablePartialVisibility (bool partial_visibility)
 Control the visibility of elements on the bottom edge.
void SetChildrenSize (int width, int height)
 Set the size of the grid element.
Size GetChildrenSize () const
 Get the size of the grid element.
void ForceChildrenSize (bool force)
 Force the grid elements size.
int GetNumColumn () const
 Get the number of columns in the grid.
int GetNumRow () const
 Get the number of rows in the grid.
void SetHeightMatchContent (bool match_content)
 Make the grid width match the size of its content.
bool GetHeightMatchContent () const
 Return True if the grid width match the size of its content.
virtual void ProcessDraw (GraphicsEngine &GfxContext, bool force_draw)
 Draw Element.

Protected Member Functions

int GetChildPos (Area *child)
AreaGetChildAtPosition (int pos)
virtual long DoFocusUp (IEvent &ievent, long TraverseInfo, long ProcessEventInfo)
virtual long DoFocusDown (IEvent &ievent, long TraverseInfo, long ProcessEventInfo)
virtual long DoFocusLeft (IEvent &ievent, long TraverseInfo, long ProcessEventInfo)
virtual long DoFocusRight (IEvent &ievent, long TraverseInfo, long ProcessEventInfo)

Detailed Description

An horizontal grid layout.

Fills the grid from left to right and going down.


Constructor & Destructor Documentation

nux::GridHLayout::GridHLayout ( NUX_FILE_LINE_PROTO  )
nux::GridHLayout::~GridHLayout ( )

Member Function Documentation

virtual long nux::GridHLayout::ComputeLayout2 ( ) [virtual]

Reimplemented from nux::Area.

virtual long nux::GridHLayout::DoFocusDown ( IEvent ievent,
long  TraverseInfo,
long  ProcessEventInfo 
) [protected, virtual]

Reimplemented from nux::Layout.

virtual long nux::GridHLayout::DoFocusLeft ( IEvent ievent,
long  TraverseInfo,
long  ProcessEventInfo 
) [protected, virtual]

Reimplemented from nux::Layout.

virtual long nux::GridHLayout::DoFocusRight ( IEvent ievent,
long  TraverseInfo,
long  ProcessEventInfo 
) [protected, virtual]

Reimplemented from nux::Layout.

virtual long nux::GridHLayout::DoFocusUp ( IEvent ievent,
long  TraverseInfo,
long  ProcessEventInfo 
) [protected, virtual]

Reimplemented from nux::Layout.

void nux::GridHLayout::EnablePartialVisibility ( bool  partial_visibility)

Control the visibility of elements on the bottom edge.

Controls how the layout places the elements at its bottom edge.

Parameters:
partial_visibilityIf True, the layout will position elements at its bottom edge even if they are partially visible.
void nux::GridHLayout::ForceChildrenSize ( bool  force)

Force the grid elements size.

Force the grid elements size to be the one provided by SetChildrenSize.

Area* nux::GridHLayout::GetChildAtPosition ( int  pos) [protected]
int nux::GridHLayout::GetChildPos ( Area child) [protected]
Size nux::GridHLayout::GetChildrenSize ( ) const

Get the size of the grid element.

Returns:
Size of the grid elements.
virtual void nux::GridHLayout::GetCompositeList ( std::list< Area * > *  ViewList) [virtual]

Reimplemented from nux::Layout.

bool nux::GridHLayout::GetHeightMatchContent ( ) const

Return True if the grid width match the size of its content.

int nux::GridHLayout::GetNumColumn ( ) const

Get the number of columns in the grid.

int nux::GridHLayout::GetNumRow ( ) const

Get the number of rows in the grid.

virtual void nux::GridHLayout::ProcessDraw ( GraphicsEngine GfxContext,
bool  force_draw 
) [virtual]

Draw Element.

Draw all elements inside the layout. If force_draw is true then the system requests that all objects redraw themselves completely.

Parameters:
force_draw
TraverseInfo
ProcessEventInfo
Returns:
The state of the Process Event.

Reimplemented from nux::Layout.

void nux::GridHLayout::SetChildrenSize ( int  width,
int  height 
)

Set the size of the grid element.

Set the size of the grid element.

Parameters:
widthWidth of elements.
heightHeight of elements.
void nux::GridHLayout::SetHeightMatchContent ( bool  match_content)

Make the grid width match the size of its content.

Parameters:
match_contentIf True, force the height of the layout to match the height of the content. This can also be achieve if the stretch factor of this layout is set to 0;

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