MGUI::LAYOUT_PANE_BASE Class Reference
Layout pane base class, not intended to be used directly. More...
#include <mgui/layout.h>
Public Member Functions | |
| LAYOUT_PANE_BASE () | |
| virtual | ~LAYOUT_PANE_BASE ()=0 |
| void | AddSpaceExpanding () |
| void | AddSpaceFixed (int size) |
| int | ComputeNumFittingCharacters (const MISTRING &str, int width) const |
| MGUI::POINT | ComputeTextSize (const MIUNICODE *str) const |
| MGUI::POINT | ComputeTextSize (TEXTID textid) const |
| MGUI::POINT | ComputeTextSize (const MISTRING &str) const |
| MGUI::POINT | ComputeTextSize (int width) const |
| void | GetBackgroundColor (COLOR &color) const |
| MGUI::POINT | GetDimensions () const |
| MDLGPARENT | GetDlgParent () const |
| int | GetTextMaxHeight () |
| Widget | GetWidget () const |
| void | Invalidate (bool erase=true) |
| bool | IsCreated () const |
| bool | IsVisible () const |
| void | SetBackgroundColor (const COLOR &color) |
| void | SetDimensions (MGUI::POINT dim) |
| void | SetEnabled (bool enabled) |
| void | SetMinimumSize (int width, int height) |
| void | SetVisible (bool visible) |
| void | UpdateLayout () |
Protected Member Functions | |
| void | SetPaneWidget (Widget PaneWidget) |
Detailed Description
Layout pane base class, not intended to be used directly.
Constructor & Destructor Documentation
| MGUI::LAYOUT_PANE_BASE::LAYOUT_PANE_BASE | ( | ) | [inline] |
Constructor.
| virtual MGUI::LAYOUT_PANE_BASE::~LAYOUT_PANE_BASE | ( | ) | [pure virtual] |
Destructor.
Member Function Documentation
| void MGUI::LAYOUT_PANE_BASE::AddSpaceExpanding | ( | ) |
Add automatically expanding whitespace item.
| void MGUI::LAYOUT_PANE_BASE::AddSpaceFixed | ( | int | size | ) |
Add whitespace item of fixed size.
| int MGUI::LAYOUT_PANE_BASE::ComputeNumFittingCharacters | ( | const MISTRING & | str, | |
| int | width | |||
| ) | const |
Compute the number of characters of the string that fit in the given width.
| MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize | ( | const MIUNICODE * | str | ) | const |
Compute size of given label text as MIUNICODE string.
- Parameters:
-
str String
| MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize | ( | TEXTID | textid | ) | const |
Compute size of given label TEXTID.
- Parameters:
-
textid Text ID
| MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize | ( | const MISTRING & | str | ) | const |
Compute size of given label text from MISTRING.
- Parameters:
-
str String
| MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize | ( | int | width | ) | const |
Compute typical size for given text width in characters.
- Parameters:
-
width Width in characters
| void MGUI::LAYOUT_PANE_BASE::GetBackgroundColor | ( | COLOR & | color | ) | const |
Get 'background' color.
| MGUI::POINT MGUI::LAYOUT_PANE_BASE::GetDimensions | ( | ) | const |
Get pane dimensions.
| MDLGPARENT MGUI::LAYOUT_PANE_BASE::GetDlgParent | ( | ) | const |
Get suitable parent for dialog launched from pane.
| int MGUI::LAYOUT_PANE_BASE::GetTextMaxHeight | ( | ) |
Get maximum text height.
| Widget MGUI::LAYOUT_PANE_BASE::GetWidget | ( | ) | const [inline] |
Get pane widget.
| void MGUI::LAYOUT_PANE_BASE::Invalidate | ( | bool | erase = true |
) |
Invalidate pane, forcing redraw.
| bool MGUI::LAYOUT_PANE_BASE::IsCreated | ( | ) | const [inline] |
Determine if pane has been created.
| bool MGUI::LAYOUT_PANE_BASE::IsVisible | ( | ) | const |
Determine if pane is visible.
Does not check if pane is contained in a non-visible parent.
| void MGUI::LAYOUT_PANE_BASE::SetBackgroundColor | ( | const COLOR & | color | ) |
Set 'background' color.
| void MGUI::LAYOUT_PANE_BASE::SetDimensions | ( | MGUI::POINT | dim | ) |
Set pane dimensions.
| void MGUI::LAYOUT_PANE_BASE::SetEnabled | ( | bool | enabled | ) |
Set 'enabled' status for all controls in pane or children therof.
Reimplemented in MGUI::LAYOUT_WIZARD_PAGE, and MGUI::LAYOUT_PAGE.
| void MGUI::LAYOUT_PANE_BASE::SetMinimumSize | ( | int | width, | |
| int | height | |||
| ) |
Set minimum size for pane.
- Parameters:
-
width Minimum width in pixels, -1 to leave unchanged height Minimum height in pixels, -1 to leave unchanged
| void MGUI::LAYOUT_PANE_BASE::SetPaneWidget | ( | Widget | PaneWidget | ) | [protected] |
| void MGUI::LAYOUT_PANE_BASE::SetVisible | ( | bool | visible | ) |
Set visibility for all controls in pane or children thereof.
| void MGUI::LAYOUT_PANE_BASE::UpdateLayout | ( | ) | [inline] |
Force update of layout.
This may be necessary if the layout is changed after the dialog/window is initially created.
The documentation for this class was generated from the following file:
- mgui/layout.h
