// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+
+/**
+ A generic orientation value.
+*/
+enum wxOrientation
+{
+ /* don't change the values of these elements, they are used elsewhere */
+ wxHORIZONTAL = 0x0004,
+ wxVERTICAL = 0x0008,
+
+ wxBOTH = wxVERTICAL | wxHORIZONTAL,
+
+ /* a mask to extract orientation from the combination of flags */
+ wxORIENTATION_MASK = wxBOTH
+};
+
+
/**
@class wxStdDialogButtonSizer
- @wxheader{sizer.h}
This class creates button layouts which conform to the standard button spacing
- and ordering defined by the platform
- or toolkit's user interface guidelines (if such things exist). By using this
- class, you can ensure that all your
+ and ordering defined by the platform or toolkit's user interface guidelines
+ (if such things exist). By using this class, you can ensure that all your
standard dialogs look correct on all major platforms. Currently it conforms to
- the Windows, GTK+ and Mac OS X
- human interface guidelines.
+ the Windows, GTK+ and Mac OS X human interface guidelines.
When there aren't interface guidelines defined for a particular platform or
- toolkit, wxStdDialogButtonSizer reverts
- to the Windows implementation.
+ toolkit, wxStdDialogButtonSizer reverts to the Windows implementation.
- To use this class, first add buttons to the sizer by calling AddButton (or
- SetAffirmativeButton, SetNegativeButton,
- or SetCancelButton) and then call Realize in order to create the actual button
- layout used. Other than these special
- operations, this sizer works like any other sizer.
+ To use this class, first add buttons to the sizer by calling
+ wxStdDialogButtonSizer::AddButton (or wxStdDialogButtonSizer::SetAffirmativeButton,
+ wxStdDialogButtonSizer::SetNegativeButton or wxStdDialogButtonSizer::SetCancelButton)
+ and then call Realize in order to create the actual button layout used.
+ Other than these special operations, this sizer works like any other sizer.
If you add a button with wxID_SAVE, on Mac OS X the button will be renamed to
- "Save" and
- the wxID_NO button will be renamed to "Don't Save" in accordance with the Mac
- OS X Human Interface Guidelines.
+ "Save" and the wxID_NO button will be renamed to "Don't Save" in accordance
+ with the Mac OS X Human Interface Guidelines.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizer Overview",
- wxDialog::CreateButtonSizer
+ @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer
*/
class wxStdDialogButtonSizer : public wxBoxSizer
{
wxStdDialogButtonSizer();
/**
- Adds a button to the wxStdDialogButtonSizer. The @a button must have
+ Adds a button to the wxStdDialogButtonSizer. The @a button must have
one of the following identifiers:
- wxID_OK
- wxID_YES
- wxID_SAVE
- wxID_APPLY
- wxID_CLOSE
- wxID_NO
- wxID_CANCEL
- wxID_HELP
- wxID_CONTEXT_HELP
+ - wxID_OK
+ - wxID_YES
+ - wxID_SAVE
+ - wxID_APPLY
+ - wxID_CLOSE
+ - wxID_NO
+ - wxID_CANCEL
+ - wxID_HELP
+ - wxID_CONTEXT_HELP
*/
void AddButton(wxButton* button);
/**
- Rearranges the buttons and applies proper spacing between buttons to make them
- match the platform or toolkit's interface guidelines.
+ Rearranges the buttons and applies proper spacing between buttons to make
+ them match the platform or toolkit's interface guidelines.
*/
void Realize();
/**
- Sets the affirmative button for the sizer. This allows you to use identifiers
- other than the standard identifiers outlined above.
+ Sets the affirmative button for the sizer.
+
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
void SetAffirmativeButton(wxButton* button);
/**
- Sets the cancel button for the sizer. This allows you to use identifiers other
- than the standard identifiers outlined above.
+ Sets the cancel button for the sizer.
+
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
void SetCancelButton(wxButton* button);
/**
- Sets the negative button for the sizer. This allows you to use identifiers
- other than the standard identifiers outlined above.
+ Sets the negative button for the sizer.
+
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
void SetNegativeButton(wxButton* button);
};
/**
@class wxSizerItem
- @wxheader{sizer.h}
The wxSizerItem class is used to track the position, size and other
- attributes of each item managed by a wxSizer. It is not usually necessary
- to use this class because the sizer elements can also be identified by
- their positions or window or sizer pointers but sometimes it may be more
- convenient to use it directly.
+ attributes of each item managed by a wxSizer.
+
+ It is not usually necessary to use this class because the sizer elements can
+ also be identified by their positions or window or sizer pointers but sometimes
+ it may be more convenient to use it directly.
@library{wxcore}
@category{winlayout}
class wxSizerItem : public wxObject
{
public:
- //@{
/**
- Construct a sizer item for tracking a subsizer.
+ Construct a sizer item for tracking a spacer.
*/
wxSizerItem(int width, int height, int proportion, int flag,
int border, wxObject* userData);
+
+ //@{
+ /**
+ Construct a sizer item for tracking a window.
+ */
wxSizerItem(wxWindow* window, const wxSizerFlags& flags);
wxSizerItem(wxWindow* window, int proportion, int flag,
int border,
wxObject* userData);
+ //@}
+
+ //@{
+ /**
+ Construct a sizer item for tracking a subsizer.
+ */
wxSizerItem(wxSizer* window, const wxSizerFlags& flags);
wxSizerItem(wxSizer* sizer, int proportion, int flag,
int border,
/**
Deletes the user data and subsizer, if any.
*/
- ~wxSizerItem();
+ virtual ~wxSizerItem();
/**
Calculates the minimum desired size for the item, including any space
needed by borders.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin();
/**
Destroy the window or the windows in a subsizer, depending on the type
of item.
*/
- void DeleteWindows();
+ virtual void DeleteWindows();
/**
Enable deleting the SizerItem without destroying the contained sizer.
/**
Get the rectangle of the item on the parent window, excluding borders.
*/
- wxRect GetRect();
+ virtual wxRect GetRect();
/**
Get the current size of the item, as set in the last Layout.
*/
- wxSize GetSize() const;
+ virtual wxSize GetSize() const;
/**
If this item is tracking a sizer, return it. @NULL otherwise.
/**
If this item is tracking a spacer, return its size.
*/
- const wxSize GetSpacer() const;
+ wxSize GetSpacer() const;
/**
Get the userData item attribute.
wxObject* GetUserData() const;
/**
- If this item is tracking a window then return it. @NULL otherwise.
+ If this item is tracking a window then return it. @NULL otherwise.
*/
wxWindow* GetWindow() const;
adjust the position and size of the item to be within that space
taking alignment and borders into account.
*/
- void SetDimension(const wxPoint& pos, const wxSize& size);
+ virtual void SetDimension(const wxPoint& pos, const wxSize& size);
/**
- Set the flag item attribute.
+ Set the flag item attribute.
*/
void SetFlag(int flag);
void SetId(int id);
/**
-
+ @todo docme.
*/
void SetInitSize(int x, int y);
/**
Set the sizer tracked by this item.
+ @deprecated @todo provide deprecation description
*/
void SetSizer(wxSizer* sizer);
/**
Set the size of the spacer tracked by this item.
+ @deprecated @todo provide deprecation description
*/
void SetSpacer(const wxSize& size);
/**
- Set the window to be tracked by thsi item.
+ Set the window to be tracked by this item.
+ @deprecated @todo provide deprecation description
*/
void SetWindow(wxWindow* window);
/**
Set the show item attribute, which sizers use to determine if the item
- is to be made part of the layout or not. If the item is tracking a
+ is to be made part of the layout or not. If the item is tracking a
window then it is shown or hidden as needed.
*/
void Show(bool show);
/**
@class wxSizerFlags
- @wxheader{sizer.h}
Container for sizer items flags providing readable names for them.
you can now write
@code
- sizer->Add(ctrl, wxSizerFlags().Expand().Border(10));
+ sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
@endcode
This is more readable and also allows you to create wxSizerFlags objects which
@code
wxSizerFlags flagsExpand(1);
- flagsExpand.Expand().Border(10);
+ flagsExpand.Expand().Border(wxALL, 10);
sizer->Add(ctrl1, flagsExpand);
sizer->Add(ctrl2, flagsExpand);
{
public:
/**
- Creates the wxSizer with the proportion specified by @e proportion.
+ Creates the wxSizer with the proportion specified by @a proportion.
*/
wxSizerFlags(int proportion = 0);
/**
- Sets the alignment of this wxSizerFlags to @e align.
+ Sets the alignment of this wxSizerFlags to @a align.
- This method replaces the previously set alignment with the specified
- one.
+ This method replaces the previously set alignment with the specified one.
- @see Top(), Left(), Right(), Bottom(), Centre()
+ @param alignment
+ Combination of @c wxALIGN_XXX bit masks.
- @param align Combination of @c wxALIGN_XXX bit masks.
+ @see Top(), Left(), Right(), Bottom(), Centre()
*/
- wxSizerFlags& Align(int align = 0);
+ wxSizerFlags& Align(int alignment);
/**
Sets the wxSizerFlags to have a border of a number of pixels specified
- by @a borderinpixels with the directions specified by @e direction.
+ by @a borderinpixels with the directions specified by @a direction.
*/
wxSizerFlags& Border(int direction, int borderinpixels);
Sets the wxSizerFlags to have a border with size as returned by
GetDefaultBorder().
- @param direction Direction(s) to apply the border in.
+ @param direction
+ Direction(s) to apply the border in.
*/
wxSizerFlags& Border(int direction = wxALL);
/**
Sets the proportion of this wxSizerFlags to @e proportion
*/
- wxSizerFlags& Proportion(int proportion = 0);
+ wxSizerFlags& Proportion(int proportion);
/**
Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT).
-/**
- @class wxNotebookSizer
- @wxheader{sizer.h}
-
- @deprecated
- This class is deprecated and should not be used in new code! It is no
- longer needed, wxNotebook control can be inserted
- into any sizer class and its minimal size will be determined correctly.
-
- wxNotebookSizer is a specialized sizer to make sizers work in connection
- with using notebooks. This sizer is different from any other sizer as you
- must not add any children to it - instead, it queries the notebook class
- itself. The only thing this sizer does is to determine the size of the
- biggest page of the notebook and report an adjusted minimal size to a more
- toplevel sizer.
-
- @library{wxbase}
- @category{winlayout}
-
- @see wxSizer, wxNotebook,
- @ref overview_sizer "Sizers overview"
-*/
-class wxNotebookSizer : public wxSizer
-{
-public:
- /**
- Constructor. It takes an associated notebook as its only parameter.
- */
- wxNotebookSizer(wxNotebook* notebook);
-
- /**
- Returns the notebook associated with the sizer.
- */
- wxNotebook* GetNotebook();
-};
-
-
-
/**
@class wxFlexGridSizer
- @wxheader{sizer.h}
A flex grid sizer is a sizer which lays out its children in a two-dimensional
- table with all table fields in one row having the same
- height and all fields in one column having the same width, but all
- rows or all columns are not necessarily the same height or width as in
- the wxGridSizer.
+ table with all table fields in one row having the same height and all fields
+ in one column having the same width, but all rows or all columns are not
+ necessarily the same height or width as in the wxGridSizer.
Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
direction but unequally ("flexibly") in the other. If the sizer is only
- flexible in one direction (this can be changed using
- wxFlexGridSizer::SetFlexibleDirection),
+ flexible in one direction (this can be changed using wxFlexGridSizer::SetFlexibleDirection),
it needs to be decided how the sizer should grow in the other ("non-flexible")
- direction in order to fill the available space. The
- wxFlexGridSizer::SetNonFlexibleGrowMode method
- serves this purpose.
+ direction in order to fill the available space.
+ The wxFlexGridSizer::SetNonFlexibleGrowMode() method serves this purpose.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizer Overview"
+ @see wxSizer, @ref overview_sizer
*/
class wxFlexGridSizer : public wxGridSizer
{
public:
//@{
/**
- Constructor for a wxGridSizer. @a rows and @a cols determine the number of
- columns and rows in the sizer - if either of the parameters is zero, it will be
- calculated to form the total number of children in the sizer, thus making the
- sizer grow dynamically. @a vgap and @a hgap define extra space between
- all children.
+ Constructor for a wxFlexGridSizer.
+
+ @a rows and @a cols determine the number of columns and rows in the sizer -
+ if either of the parameters is zero, it will be calculated to form the
+ total number of children in the sizer, thus making the sizer grow
+ dynamically.
+
+ @a vgap and @a hgap define extra space between all children.
*/
wxFlexGridSizer(int rows, int cols, int vgap, int hgap);
wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
/**
Specifies that column @a idx (starting from zero) should be grown if
there is extra space available to the sizer.
- The @a proportion parameter has the same meaning as the stretch factor for
- the sizers() except that if all proportions are 0,
- then all columns are resized equally (instead of not being resized at all).
+
+ The @a proportion parameter has the same meaning as the stretch factor
+ for the sizers() except that if all proportions are 0, then all columns
+ are resized equally (instead of not being resized at all).
+
+ Notice that the row must not be already growable, if you need to change
+ the proportion you must call RemoveGrowableCol() first and then make it
+ growable (with a different proportion) again. You can use IsColGrowable()
+ to check whether a column is already growable.
*/
void AddGrowableCol(size_t idx, int proportion = 0);
/**
Specifies that row idx (starting from zero) should be grown if there
is extra space available to the sizer.
- See AddGrowableCol() for the description
- of @a proportion parameter.
+
+ This is identical to AddGrowableCol() except that it works with rows
+ and not columns.
*/
void AddGrowableRow(size_t idx, int proportion = 0);
Returns a wxOrientation value that specifies whether the sizer flexibly
resizes its columns, rows, or both (default).
- @return One of the following values:
+ @return
+ One of the following values:
+ - wxVERTICAL: Rows are flexibly sized.
+ - wxHORIZONTAL: Columns are flexibly sized.
+ - wxBOTH: Both rows and columns are flexibly sized (this is the default value).
@see SetFlexibleDirection()
*/
Returns the value that specifies how the sizer grows in the "non-flexible"
direction if there is one.
- @return One of the following values:
+ The behaviour of the elements in the flexible direction (i.e. both rows
+ and columns by default, or rows only if GetFlexibleDirection() is @c
+ wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed
+ by their proportion as specified in the call to AddGrowableRow() or
+ AddGrowableCol(). What happens in the other direction depends on the
+ value of returned by this function as described below.
+
+ @return
+ One of the following values:
+ - wxFLEX_GROWMODE_NONE: Sizer doesn't grow its elements at all in
+ the non-flexible direction.
+ - wxFLEX_GROWMODE_SPECIFIED: Sizer honors growable columns/rows set
+ with AddGrowableCol() and AddGrowableRow() in the non-flexible
+ direction as well. In this case equal sizing applies to minimum
+ sizes of columns or rows (this is the default value).
+ - wxFLEX_GROWMODE_ALL: Sizer equally stretches all columns or rows in
+ the non-flexible direction, independently of the proportions
+ applied in the flexible direction.
- @see SetFlexibleDirection(),
- SetNonFlexibleGrowMode()
+ @see SetFlexibleDirection(), SetNonFlexibleGrowMode()
*/
- int GetNonFlexibleGrowMode() const;
+ wxFlexSizerGrowMode GetNonFlexibleGrowMode() const;
+
+ /**
+ Returns @true if column @a idx is growable.
+
+ @since 2.9.0
+ */
+ bool IsColGrowable(size_t idx);
+
+ /**
+ Returns @true if row @a idx is growable.
+
+ @since 2.9.0
+ */
+ bool IsRowGrowable(size_t idx);
/**
Specifies that column idx is no longer growable.
void RemoveGrowableRow(size_t idx);
/**
- Specifies whether the sizer should flexibly resize its columns, rows, or
- both. Argument @c direction can be @c wxVERTICAL, @c wxHORIZONTAL
- or @c wxBOTH (which is the default value). Any other value is ignored. See
- @ref GetFlexibleDirection() GetFlexibleDirection for the
- explanation of these values.
+ Specifies whether the sizer should flexibly resize its columns, rows, or both.
+
+ Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH
+ (which is the default value). Any other value is ignored.
+ See GetFlexibleDirection() for the explanation of these values.
Note that this method does not trigger relayout.
*/
void SetFlexibleDirection(int direction);
/**
Specifies how the sizer should grow in the non-flexible direction if
- there is one (so
- SetFlexibleDirection() must have
- been called previously). Argument @a mode can be one of those documented in
- GetNonFlexibleGrowMode(), please
- see there for their explanation.
+ there is one (so SetFlexibleDirection() must have been called previously).
+
+ Argument @a mode can be one of those documented in GetNonFlexibleGrowMode(),
+ please see there for their explanation.
Note that this method does not trigger relayout.
*/
void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode);
/**
@class wxSizer
- @wxheader{sizer.h}
wxSizer is the abstract base class used for laying out subwindows in a window.
- You
- cannot use wxSizer directly; instead, you will have to use one of the sizer
- classes derived from it. Currently there are wxBoxSizer,
- wxStaticBoxSizer,
- wxGridSizer,
- wxFlexGridSizer,
- wxWrapSizer
- and wxGridBagSizer.
+ You cannot use wxSizer directly; instead, you will have to use one of the sizer
+ classes derived from it. Currently there are wxBoxSizer, wxStaticBoxSizer,
+ wxGridSizer, wxFlexGridSizer, wxWrapSizer and wxGridBagSizer.
The layout algorithm used by sizers in wxWidgets is closely related to layout
in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit.
- It is
- based upon the idea of the individual subwindows reporting their minimal
- required
- size and their ability to get stretched if the size of the parent window has
- changed.
+ It is based upon the idea of the individual subwindows reporting their minimal
+ required size and their ability to get stretched if the size of the parent window
+ has changed.
+
This will most often mean that the programmer does not set the original size of
a dialog in the beginning, rather the dialog will be assigned a sizer and this
- sizer
- will be queried about the recommended size. The sizer in turn will query its
- children, which can be normal windows, empty space or other sizers, so that
+ sizer will be queried about the recommended size. The sizer in turn will query
+ its children, which can be normal windows, empty space or other sizers, so that
a hierarchy of sizers can be constructed. Note that wxSizer does not derive
- from wxWindow
- and thus does not interfere with tab ordering and requires very little
- resources compared
- to a real window on screen.
+ from wxWindow and thus does not interfere with tab ordering and requires very little
+ resources compared to a real window on screen.
What makes sizers so well fitted for use in wxWidgets is the fact that every
- control
- reports its own minimal size and the algorithm can handle differences in font
- sizes
- or different window (dialog item) sizes on different platforms without
- problems. If e.g.
- the standard font as well as the overall design of Motif widgets requires more
- space than
- on Windows, the initial dialog size will automatically be bigger on Motif than
- on Windows.
+ control reports its own minimal size and the algorithm can handle differences in
+ font sizes or different window (dialog item) sizes on different platforms without
+ problems. If e.g. the standard font as well as the overall design of Motif widgets
+ requires more space than on Windows, the initial dialog size will automatically
+ be bigger on Motif than on Windows.
Sizers may also be used to control the layout of custom drawn items on the
- window. The Add(), Insert(), and Prepend() functions return a pointer to
- the newly added wxSizerItem. Just add empty space of the desired size and
- attributes, and then use the wxSizerItem::GetRect() method to determine
- where the drawing operations should take place.
+ window. The wxSizer::Add(), wxSizer::Insert(), and wxSizer::Prepend() functions
+ return a pointer to the newly added wxSizerItem.
+ Just add empty space of the desired size and attributes, and then use the
+ wxSizerItem::GetRect() method to determine where the drawing operations
+ should take place.
Please notice that sizers, like child windows, are owned by the library and
- will be deleted by it which implies that they must be allocated on the
- heap. However if you create a sizer and do not add it to another sizer or
+ will be deleted by it which implies that they must be allocated on the heap.
+ However if you create a sizer and do not add it to another sizer or
window, the library wouldn't be able to delete such an orphan sizer and in
this, and only this, case it should be deleted explicitly.
- @b wxPython note: If you wish to create a sizer class in wxPython you should
+ @beginWxPythonOnly
+ If you wish to create a sizer class in wxPython you should
derive the class from @c wxPySizer in order to get Python-aware
capabilities for the various virtual methods.
+ @endWxPythonOnly
@anchor wxsizer_flags
@par wxSizer flags
+
The "flag" argument accepted by wxSizeItem constructors and other
functions, e.g. wxSizer::Add(), is OR-combination of the following flags.
Two main behaviours are defined using these flags. One is the border around
be added. The other flags determine how the sizer item behaves when the
space allotted to the sizer changes, and is somewhat dependent on the
specific kind of sizer used.
+
@beginDefList
@itemdef{wxTOP<br>
wxBOTTOM<br>
border if any.}
@endDefList
-
@library{wxcore}
@category{winlayout}
- @see @ref overview_sizer "Sizer Overview"
+ @see @ref overview_sizer
*/
class wxSizer : public wxObject
{
public:
/**
- The constructor. Note that wxSizer is an abstract base class and may not
- be instantiated.
+ The constructor.
+ Note that wxSizer is an abstract base class and may not be instantiated.
*/
wxSizer();
/**
The destructor.
*/
- ~wxSizer();
+ virtual ~wxSizer();
/**
Appends a child to the sizer.
derived classes when sizing information is more complex than the
proportion and flag will allow for.
*/
- wxSizerItem* Add(wxWindow* window, int proportion = 0,
+ wxSizerItem* Add(wxWindow* window,
+ int proportion = 0,
int flag = 0,
int border = 0,
wxObject* userData = NULL);
derived classes when sizing information is more complex than the
proportion and flag will allow for.
*/
- wxSizerItem* Add(wxSizer* sizer, int proportion = 0,
+ wxSizerItem* Add(wxSizer* sizer,
+ int proportion = 0,
int flag = 0,
int border = 0,
wxObject* userData = NULL);
derived classes when sizing information is more complex than the
proportion and flag will allow for.
*/
- wxSizerItem* Add(int width, int height, int proportion = 0,
+ wxSizerItem* Add(int width, int height,
+ int proportion = 0,
int flag = 0,
int border = 0,
wxObject* userData = NULL);
/**
- Adds non-stretchable space to the sizer. More readable way of calling
+ Adds non-stretchable space to the sizer.
+ More readable way of calling:
+ @code
wxSizer::Add(size, size, 0).
+ @endcode
*/
wxSizerItem* AddSpacer(int size);
/**
- Adds stretchable space to the sizer. More readable way of calling
+ Adds stretchable space to the sizer.
+ More readable way of calling:
+ @code
wxSizer::Add(0, 0, prop).
+ @endcode
*/
wxSizerItem* AddStretchSpacer(int prop = 1);
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children's minimal sizes.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin() = 0;
/**
- Detaches all children from the sizer. If @a delete_windows is @true then
- child windows will also be deleted.
+ Detaches all children from the sizer.
+ If @a delete_windows is @true then child windows will also be deleted.
*/
- void Clear(bool delete_windows = false);
+ virtual void Clear(bool delete_windows = false);
/**
Computes client area size for @a window so that it matches the sizer's
minimal size. Unlike GetMinSize(), this method accounts for other
constraints imposed on @e window, namely display's size (returned size
will never be too large for the display) and maximum window size if
- previously set by wxWindow::SetMaxSize(). The returned value is
- suitable for passing to wxWindow::SetClientSize() or
+ previously set by wxWindow::SetMaxSize().
+
+ The returned value is suitable for passing to wxWindow::SetClientSize() or
wxWindow::SetMinClientSize().
@since 2.8.8
/**
Detach the child @a window from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
-
+
Returns @true if the child item was found and detached, @false otherwise.
@see Remove()
*/
- bool Detach(wxWindow* window);
+ virtual bool Detach(wxWindow* window);
/**
Detach the child @a sizer from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
-
+
Returns @true if the child item was found and detached, @false otherwise.
-
+
@see Remove()
*/
- bool Detach(wxSizer* sizer);
+ virtual bool Detach(wxSizer* sizer);
/**
Detach a item at position @a index from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
Returns @true if the child item was found and detached, @false otherwise.
@see Remove()
*/
- bool Detach(size_t index);
+ virtual bool Detach(int index);
/**
Tell the sizer to resize the @a window so that its client area matches the
- sizer's minimal size
- (ComputeFittingClientSize() is called
- to determine it).
- This is commonly done in the constructor of the window
- itself, see sample in the description
- of wxBoxSizer. Returns the new window size.
+ sizer's minimal size (ComputeFittingClientSize() is called to determine it).
+ This is commonly done in the constructor of the window itself, see sample
+ in the description of wxBoxSizer.
+
+ @return The new window size.
@see ComputeFittingClientSize(), ComputeFittingWindowSize()
*/
/**
Tell the sizer to resize the virtual size of the @a window to match the sizer's
- minimal size. This will not alter the on screen size of the window, but may
+ minimal size. This will not alter the on screen size of the window, but may
cause the addition/removal/alteration of scrollbars required to view the virtual
area in windows which manage it.
*/
void FitInside(wxWindow* window);
+ //@{
/**
- Returns the list of the items in this sizer. The elements of type-safe
- wxList @a wxSizerItemList are pointers to objects of type
- @ref wxSizerItem "wxSizerItem".
+ Returns the list of the items in this sizer.
+
+ The elements of type-safe wxList @c wxSizerItemList are pointers to
+ objects of type wxSizerItem.
*/
wxSizerItemList& GetChildren();
-
- /**
- Returns the list of the items in this sizer. The elements of type-safe
- wxList @a wxSizerItemList are pointers to objects of type
- @ref wxSizerItem "wxSizerItem".
- */
const wxSizerItemList& GetChildren() const;
+ //@}
/**
Returns the window this sizer is used in or @NULL if none.
wxWindow* GetContainingWindow() const;
/**
- Finds wxSizerItem which holds the given @a window
+ Finds wxSizerItem which holds the given @a window.
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
-
+
/**
- Finds wxSizerItem which holds the given @a sizer
+ Finds wxSizerItem which holds the given @a sizer.
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
-
+
wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
+
/**
- Finds wxSizerItem which is located in the sizer at position
- @a index.
+ Finds wxSizerItem which is located in the sizer at position @a index.
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
wxSizerItem* GetItem(size_t index);
/**
- Finds item of the sizer which has the given @e id. This @a id is not the
- window id but the id of the wxSizerItem itself. This is mainly useful for
- retrieving the sizers created from XRC resources.
+ Finds item of the sizer which has the given @e id.
+ This @a id is not the window id but the id of the wxSizerItem itself.
+ This is mainly useful for retrieving the sizers created from XRC resources.
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
wxSizerItem* GetItemById(int id, bool recursive = false);
/**
- Returns the minimal size of the sizer. This is either the combined minimal
- size of all the children and their borders or the minimal size set by
- SetMinSize(), depending on which is bigger.
+ Returns the minimal size of the sizer.
+
+ This is either the combined minimal size of all the children and their
+ borders or the minimal size set by SetMinSize(), depending on which is bigger.
Note that the returned value is client size, not window size.
In particular, if you use the value to set toplevel window's minimal or
- actual size, use wxWindow::SetMinClientSize
- or wxWindow::SetClientSize, not
- wxWindow::SetMinSize
- or wxWindow::SetSize.
+ actual size, use wxWindow::SetMinClientSize() or wxWindow::SetClientSize(),
+ not wxWindow::SetMinSize() or wxWindow::SetSize().
*/
wxSize GetMinSize();
/**
Returns the current position of the sizer.
*/
- wxPoint GetPosition();
+ wxPoint GetPosition() const;
/**
Returns the current size of the sizer.
*/
- wxSize GetSize();
+ wxSize GetSize() const;
/**
Hides the child @a window.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
/**
Hides the child @a sizer.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
/**
Hides the item at position @a index.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
bool Hide(size_t index);
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at @a index.
See Add() for the meaning of the other parameters.
*/
const wxSizerFlags& flags);
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at @a index.
See Add() for the meaning of the other parameters.
*/
wxObject* userData = NULL);
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at @a index.
See Add() for the meaning of the other parameters.
*/
const wxSizerFlags& flags);
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at @a index.
See Add() for the meaning of the other parameters.
*/
wxObject* userData = NULL);
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at @a index.
See Add() for the meaning of the other parameters.
*/
wxObject* userData = NULL);
/**
- Inserts non-stretchable space to the sizer. More readable way of calling
- wxSizer::Insert(size, size, 0).
+ Inserts non-stretchable space to the sizer.
+ More readable way of calling wxSizer::Insert(size, size, 0).
*/
wxSizerItem* InsertSpacer(size_t index, int size);
/**
- Inserts stretchable space to the sizer. More readable way of calling
- wxSizer::Insert(0, 0, prop).
+ Inserts stretchable space to the sizer.
+ More readable way of calling wxSizer::Insert(0, 0, prop).
*/
wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
/**
- Returns @true if the @e window is shown.
+ Returns @true if the @a window is shown.
@see Hide(), Show(), wxSizerItem::IsShown()
*/
bool IsShown(wxWindow* window) const;
/**
- Returns @true if the @e sizer is shown.
+ Returns @true if the @a sizer is shown.
@see Hide(), Show(), wxSizerItem::IsShown()
*/
/**
Call this to force layout of the children anew, e.g. after having added a child
to or removed a child (window, other sizer or space) from the sizer while
- keeping
- the current dimension.
+ keeping the current dimension.
*/
- void Layout();
+ virtual void Layout();
/**
Same as Add(), but prepends the items to the beginning of the
wxObject* userData = NULL);
/**
- Prepends non-stretchable space to the sizer. More readable way of
- calling wxSizer::Prepend(size, size, 0).
+ Prepends non-stretchable space to the sizer.
+ More readable way of calling wxSizer::Prepend(size, size, 0).
*/
wxSizerItem* PrependSpacer(int size);
/**
- Prepends stretchable space to the sizer. More readable way of calling
- wxSizer::Prepend(0, 0, prop).
+ Prepends stretchable space to the sizer.
+ More readable way of calling wxSizer::Prepend(0, 0, prop).
*/
wxSizerItem* PrependStretchSpacer(int prop = 1);
Here, the sizer will do the actual calculation of its children's
positions and sizes.
*/
- void RecalcSizes();
+ virtual void RecalcSizes() = 0;
/**
Removes a child window from the sizer, but does @b not destroy it
@return @true if the child item was found and removed, @false otherwise.
*/
- bool Remove(wxWindow* window);
+ virtual bool Remove(wxWindow* window);
/**
Removes a sizer child from the sizer and destroys it.
@return @true if the child item was found and removed, @false otherwise.
*/
- bool Remove(wxSizer* sizer);
+ virtual bool Remove(wxSizer* sizer);
/**
Removes a child from the sizer and destroys it if it is a sizer or a
place, call Layout() to update the layout "on screen" after
removing a child from the sizer.
- @param index The position of the child in the sizer, e.g. 0 for the
- first item.
+ @param index
+ The position of the child in the sizer, e.g. 0 for the first item.
@return @true if the child item was found and removed, @false otherwise.
*/
- bool Remove(size_t index);
+ virtual bool Remove(int index);
/**
- Detaches the given @a oldwin from the sizer and
- replaces it with the given @a newwin. The detached
- child window is @b not deleted (because windows are
- owned by their parent window, not the sizer).
-
+ Detaches the given @a oldwin from the sizer and replaces it with the
+ given @a newwin. The detached child window is @b not deleted (because
+ windows are owned by their parent window, not the sizer).
+
Use parameter @a recursive to search the given element recursively in subsizers.
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
- bool Replace(wxWindow* oldwin, wxWindow* newwin,
- bool recursive = false);
-
+ virtual bool Replace(wxWindow* oldwin, wxWindow* newwin,
+ bool recursive = false);
+
/**
- Detaches the given @a oldsz from the sizer and
- replaces it with the given @a newsz. The detached
- child sizer is deleted.
-
+ Detaches the given @a oldsz from the sizer and replaces it with the
+ given @a newsz. The detached child sizer is deleted.
+
Use parameter @a recursive to search the given element recursively in subsizers.
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
- bool Replace(wxSizer* oldsz, wxSizer* newsz,
- bool recursive = false);
-
+ virtual bool Replace(wxSizer* oldsz, wxSizer* newsz,
+ bool recursive = false);
+
/**
Detaches the given item at position @a index from the sizer and
replaces it with the given wxSizerItem @a newitem.
-
+
The detached child is deleted @b only if it is a sizer or a spacer
(but not if it is a wxWindow because windows are owned by their
parent window, not the sizer).
-
+
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
- bool Replace(size_t index, wxSizerItem* newitem);
+ virtual bool Replace(size_t index, wxSizerItem* newitem);
/**
Call this to force the sizer to take the given dimension and thus force
rules defined by the parameter in the Add() and Prepend() methods.
*/
void SetDimension(int x, int y, int width, int height);
-
+
/**
@overload
*/
/**
Set an item's minimum size by window, sizer, or position.
- The item will be found recursively in the sizer's descendants. This
- function enables an application to set the size of an item after
+ The item will be found recursively in the sizer's descendants.
+ This function enables an application to set the size of an item after
initial creation.
@see wxSizerItem::SetMinSize()
*/
- void SetItemMinSize(wxWindow* window, int width, int height);
+ bool SetItemMinSize(wxWindow* window, int width, int height);
/**
Set an item's minimum size by window, sizer, or position.
- The item will be found recursively in the sizer's descendants. This
- function enables an application to set the size of an item after
+ The item will be found recursively in the sizer's descendants.
+ This function enables an application to set the size of an item after
initial creation.
@see wxSizerItem::SetMinSize()
*/
- void SetItemMinSize(wxSizer* sizer, int width, int height);
+ bool SetItemMinSize(wxSizer* sizer, int width, int height);
/**
Set an item's minimum size by window, sizer, or position.
- The item will be found recursively in the sizer's descendants. This
- function enables an application to set the size of an item after
+ The item will be found recursively in the sizer's descendants.
+ This function enables an application to set the size of an item after
initial creation.
@see wxSizerItem::SetMinSize()
*/
- void SetItemMinSize(size_t index, int width, int height);
+ bool SetItemMinSize(size_t index, int width, int height);
/**
- Call this to give the sizer a minimal size. Normally, the sizer will
- calculate its minimal size based purely on how much space its children
- need. After calling this method GetMinSize() will return either the
- minimal size as requested by its children or the minimal size set here,
- depending on which is bigger.
+ Call this to give the sizer a minimal size.
+
+ Normally, the sizer will calculate its minimal size based purely on how
+ much space its children need. After calling this method GetMinSize()
+ will return either the minimal size as requested by its children or the
+ minimal size set here, depending on which is bigger.
*/
void SetMinSize(const wxSize& size);
void SetMinSize(int width, int height);
/**
- This method first calls Fit() and then
- wxTopLevelWindow::SetSizeHints on the @e window
- passed to it. This only makes sense when @a window is actually a
- wxTopLevelWindow such as a wxFrame or a
- wxDialog, since SetSizeHints only has any effect in these classes.
+ This method first calls Fit() and then wxTopLevelWindow::SetSizeHints()
+ on the @a window passed to it.
+
+ This only makes sense when @a window is actually a wxTopLevelWindow such
+ as a wxFrame or a wxDialog, since SetSizeHints only has any effect in these classes.
It does nothing in normal windows or controls.
- This method is implicitly used by wxWindow::SetSizerAndFit
- which is commonly invoked in the constructor of a toplevel window itself (see
- the sample in the description of wxBoxSizer) if the
- toplevel window is resizable.
+
+ This method is implicitly used by wxWindow::SetSizerAndFit() which is
+ commonly invoked in the constructor of a toplevel window itself (see
+ the sample in the description of wxBoxSizer) if the toplevel window is
+ resizable.
*/
void SetSizeHints(wxWindow* window);
/**
Tell the sizer to set the minimal size of the @a window virtual area to match
- the sizer's
- minimal size. For windows with managed scrollbars this will set them
+ the sizer's minimal size. For windows with managed scrollbars this will set them
appropriately.
+ @deprecated @todo provide deprecation description
+
@see wxScrolled::SetScrollbars()
*/
void SetVirtualSizeHints(wxWindow* window);
/**
Shows or hides the @a window.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Use parameter @a recursive to show or hide elements found in subsizers.
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
/**
Shows or hides @a sizer.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Use parameter @a recursive to show or hide elements found in subsizers.
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
/**
Shows the item at @a index.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
/**
@class wxGridSizer
- @wxheader{sizer.h}
A grid sizer is a sizer which lays out its children in a two-dimensional
- table with all table fields having the same size,
- i.e. the width of each field is the width of the widest child,
- the height of each field is the height of the tallest child.
+ table with all table fields having the same size, i.e. the width of each
+ field is the width of the widest child, the height of each field is the
+ height of the tallest child.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizer Overview"
+ @see wxSizer, @ref overview_sizer
*/
class wxGridSizer : public wxSizer
{
public:
//@{
/**
- Constructor for a wxGridSizer. @a rows and @a cols determine the number of
- columns and rows in the sizer - if either of the parameters is zero, it will be
- calculated to form the total number of children in the sizer, thus making the
- sizer grow dynamically. @a vgap and @a hgap define extra space between
- all children.
+ Constructor for a wxGridSizer.
+
+ @a rows and @a cols determine the number of columns and rows in the sizer -
+ if either of the parameters is zero, it will be calculated to form the
+ total number of children in the sizer, thus making the sizer grow dynamically.
+
+ @a vgap and @a hgap define extra space between all children.
*/
wxGridSizer(int rows, int cols, int vgap, int hgap);
wxGridSizer(int cols, int vgap = 0, int hgap = 0);
/**
Returns the number of columns in the sizer.
*/
- int GetCols();
+ int GetCols() const;
/**
Returns the horizontal gap (in pixels) between cells in the sizer.
*/
- int GetHGap();
+ int GetHGap() const;
/**
Returns the number of rows in the sizer.
*/
- int GetRows();
+ int GetRows() const;
/**
Returns the vertical gap (in pixels) between the cells in the sizer.
*/
- int GetVGap();
+ int GetVGap() const;
/**
Sets the number of columns in the sizer.
/**
@class wxStaticBoxSizer
- @wxheader{sizer.h}
wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static
- box around the sizer. This static box may be either created independently or
- the sizer may create it itself as a convenience. In any case, the sizer owns
- the wxStaticBox control and will delete it if it is
- deleted.
+ box around the sizer.
+ This static box may be either created independently or the sizer may create
+ it itself as a convenience. In any case, the sizer owns the wxStaticBox control
+ and will delete it, if it is deleted.
@library{wxcore}
@category{winlayout}
- @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
- "Sizer Overview"
+ @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
*/
class wxStaticBoxSizer : public wxBoxSizer
{
public:
- //@{
/**
- The first constructor uses an already existing static box. It takes the
- associated static box and the orientation @e orient, which can be either
- @c wxVERTICAL or @c wxHORIZONTAL as parameters.
- The second one creates a new static box with the given label and parent window.
+ This constructor uses an already existing static box.
+
+ It takes the associated static box and the orientation @a orient, which
+ can be either @c wxVERTICAL or @c wxHORIZONTAL as parameters.
*/
wxStaticBoxSizer(wxStaticBox* box, int orient);
- wxStaticBoxSizer(int orient, wxWindow parent,
+
+ /**
+ This constructor creates a new static box with the given label and parent window.
+ */
+ wxStaticBoxSizer(int orient, wxWindow *parent,
const wxString& label = wxEmptyString);
- //@}
/**
Returns the static box associated with the sizer.
*/
- wxStaticBox* GetStaticBox();
+ wxStaticBox* GetStaticBox() const;
};
/**
@class wxBoxSizer
- @wxheader{sizer.h}
The basic idea behind a box sizer is that windows will most often be laid out
- in rather
- simple basic geometry, typically in a row or a column or several hierarchies of
- either.
+ in rather simple basic geometry, typically in a row or a column or several
+ hierarchies of either.
- For more information, please see @ref overview_sizer_box
- "Programming with wxBoxSizer".
+ For more information, please see @ref overview_sizer_box.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizers Overview"
+ @see wxSizer, @ref overview_sizer
*/
class wxBoxSizer : public wxSizer
{
wxBoxSizer(int orient);
/**
- Implements the calculation of a box sizer's minimal. It is used internally
- only and must not be called by the user. Documented for information.
+ Implements the calculation of a box sizer's minimal.
+
+ It is used internally only and must not be called by the user.
+ Documented for information.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin();
/**
Returns the orientation of the box sizer, either wxVERTICAL
or wxHORIZONTAL.
*/
- int GetOrientation();
+ int GetOrientation() const;
/**
Implements the calculation of a box sizer's dimensions and then sets
- the size of its children (calling wxWindow::SetSize
- if the child is a window). It is used internally only and must not be called
- by the user (call Layout() if you want to resize). Documented for information.
+ the size of its children (calling wxWindow::SetSize if the child is a window).
+
+ It is used internally only and must not be called by the user
+ (call Layout() if you want to resize). Documented for information.
*/
void RecalcSizes();
};
projects / wxWidgets.git / blobdiff