View Source wxSizerFlags (wx v2.4.3)
Container for sizer items flags providing readable names for them.
Normally, when you add an item to a sizer via wxSizer:add/4, you have to specify a lot of flags and
parameters which can be unwieldy. This is where wxSizerFlags comes in: it allows you
to specify all parameters using the named methods instead. For example, instead of
you can now write
This is more readable and also allows you to create wxSizerFlags objects which can be
reused for several sizer items.
Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
object itself to allowing chaining multiple methods calls like in the examples above.
See: wxSizer
wxWidgets docs: wxSizerFlags
Summary
Functions
Sets the alignment of this wxSizerFlags to align.
Equivalent to border(This, []).
Sets the wxSizerFlags to have a border with size as returned by GetDefaultBorder()
(not implemented in wx).
Sets the wxSizerFlags to have a border of a number of pixels specified by borderinpixels
with the directions specified by direction.
Sets the object of the wxSizerFlags to center itself in the area it is given.
Equivalent to: center/1
Destroys the object
Sets the object of the wxSizerFlags to expand to fill as much area as it can.
Aligns the object to the left, similar for Align(wxALIGN\_LEFT).
Creates the wxSizer with the proportion specified by proportion.
Sets the proportion of this wxSizerFlags to proportion.
Aligns the object to the right, similar for Align(wxALIGN\_RIGHT).
Types
-type wxSizerFlags() :: wx:wx_object().
Functions
-spec align(This, Alignment) -> wxSizerFlags() when This :: wxSizerFlags(), Alignment :: integer().
Sets the alignment of this wxSizerFlags to align.
This method replaces the previously set alignment with the specified one.
See:
-spec border(This) -> wxSizerFlags() when This :: wxSizerFlags().
Equivalent to border(This, []).
-spec border(This, [Option]) -> wxSizerFlags() when This :: wxSizerFlags(), Option :: {direction, integer()}.
Sets the wxSizerFlags to have a border with size as returned by GetDefaultBorder()
(not implemented in wx).
-spec border(This, Direction, Borderinpixels) -> wxSizerFlags() when This :: wxSizerFlags(), Direction :: integer(), Borderinpixels :: integer().
Sets the wxSizerFlags to have a border of a number of pixels specified by borderinpixels
with the directions specified by direction.
Prefer to use the overload below or DoubleBorder() (not implemented in wx) or TripleBorder()
(not implemented in wx) versions instead of hard-coding the border value in pixels to
avoid too small borders on devices with high DPI displays.
-spec center(This) -> wxSizerFlags() when This :: wxSizerFlags().
Sets the object of the wxSizerFlags to center itself in the area it is given.
-spec centre(This) -> wxSizerFlags() when This :: wxSizerFlags().
Equivalent to: center/1
-spec destroy(This :: wxSizerFlags()) -> ok.
Destroys the object
-spec expand(This) -> wxSizerFlags() when This :: wxSizerFlags().
Sets the object of the wxSizerFlags to expand to fill as much area as it can.
-spec left(This) -> wxSizerFlags() when This :: wxSizerFlags().
Aligns the object to the left, similar for Align(wxALIGN\_LEFT).
Unlike align/2, this method doesn't change the vertical alignment of the item.
-spec new() -> wxSizerFlags().
Equivalent to new([]).
-spec new([Option]) -> wxSizerFlags() when Option :: {proportion, integer()}.
Creates the wxSizer with the proportion specified by proportion.
-spec proportion(This, Proportion) -> wxSizerFlags() when This :: wxSizerFlags(), Proportion :: integer().
Sets the proportion of this wxSizerFlags to proportion.
-spec right(This) -> wxSizerFlags() when This :: wxSizerFlags().
Aligns the object to the right, similar for Align(wxALIGN\_RIGHT).
Unlike align/2, this method doesn't change the vertical alignment of the item.