nux::GridVLayout Class Reference
A vertical grid layout. More...
#include <Nux/GridVLayout.h>
Public Member Functions | |
| GridVLayout (NUX_FILE_LINE_PROTO) | |
| ~GridVLayout () | |
| 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 | SetWidthMatchContent (bool match_content) |
| Make the grid width match the size of its content. | |
| bool | GetWidthMatchContent () const |
| Return True if the grid width match the size of its content. | |
| virtual void | ProcessDraw (GraphicsEngine &GfxContext, bool force_draw) |
| Draw Element. | |
Detailed Description
A vertical grid layout.
Fills the grid from top to bottom and going right.
Constructor & Destructor Documentation
| nux::GridVLayout::GridVLayout | ( | NUX_FILE_LINE_PROTO | ) |
| nux::GridVLayout::~GridVLayout | ( | ) |
Member Function Documentation
| virtual long nux::GridVLayout::ComputeLayout2 | ( | ) | [virtual] |
Reimplemented from nux::Area.
| void nux::GridVLayout::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_visibility If True, the layout will position elements at its bottom edge even if they are partially visible.
| void nux::GridVLayout::ForceChildrenSize | ( | bool | force | ) |
Force the grid elements size.
Force the grid elements size to be the one provided by SetChildrenSize.
| Size nux::GridVLayout::GetChildrenSize | ( | ) | const |
Get the size of the grid element.
- Returns:
- Size of the grid elements.
| virtual void nux::GridVLayout::GetCompositeList | ( | std::list< Area * > * | ViewList | ) | [virtual] |
Reimplemented from nux::Layout.
| int nux::GridVLayout::GetNumColumn | ( | ) | const |
Get the number of columns in the grid.
| int nux::GridVLayout::GetNumRow | ( | ) | const |
Get the number of rows in the grid.
| bool nux::GridVLayout::GetWidthMatchContent | ( | ) | const |
Return True if the grid width match the size of its content.
| virtual void nux::GridVLayout::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::GridVLayout::SetChildrenSize | ( | int | width, |
| int | height | ||
| ) |
Set the size of the grid element.
Set the size of the grid element.
- Parameters:
-
width Width of elements. height Height of elements.
| void nux::GridVLayout::SetWidthMatchContent | ( | bool | match_content | ) |
Make the grid width match the size of its content.
- Parameters:
-
match_content If True, force the width 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:
- Nux/GridVLayout.h
