Added the wx.SizerFlags class, and also added AddF, InsertF and

PrependF methods to wx.Sizer.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_8_BRANCH@44570 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2007-02-26 23:22:25 +00:00
parent df1a8b2e0c
commit f1cafba603
9 changed files with 4506 additions and 483 deletions

View File

@@ -25,10 +25,10 @@ class TestPanel(wx.Panel):
ctrl = wx.animate.AnimationCtrl(self, -1, ani) ctrl = wx.animate.AnimationCtrl(self, -1, ani)
ctrl.SetUseWindowBackgroundColour() ctrl.SetUseWindowBackgroundColour()
ctrl.Play() ctrl.Play()
sizer.Add(ctrl, 0, wx.ALL, 10) sizer.AddF(ctrl, wx.SizerFlags().Border(wx.ALL, 10))
border = wx.BoxSizer() border = wx.BoxSizer()
border.Add(sizer, 1, wx.EXPAND|wx.ALL, 20) border.AddF(sizer, wx.SizerFlags(1).Expand().Border(wx.ALL, 20))
self.SetSizer(border) self.SetSizer(border)

View File

@@ -16,6 +16,18 @@ module) and also as a non mix-in tool (using wx.lib.inspect.InspectionTool).
Add wx.lib.mixins.treemixin from Frank Niessink. Add wx.lib.mixins.treemixin from Frank Niessink.
Added the wx.SizerFlags class, and also added AddF, InsertF and
PrependF methods to wx.Sizer. The wxSizerFlags class provides a
convienient and easier to read way to add items to a sizer. For
example, instead of writing::
sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
you can now write::
sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(10))

View File

@@ -21,6 +21,155 @@
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
%newgroup; %newgroup;
DocStr(wxSizerFlags,
"Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
to specify a lot of flags and parameters which can be unwieldy. This
is where wx.SizerFlags comes in: it allows you to specify all
parameters using the named methods instead. For example, instead of::
sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
you can now write::
sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(10))
This is more readable and also allows you to create wx.SizerFlags
objects which can be reused for several sizer items.::
flagsExpand = wx.SizerFlags(1)
flagsExpand.Expand().Border(10)
sizer.AddF(ctrl1, flagsExpand)
sizer.AddF(ctrl2, flagsExpand)
Note that by specification, all methods of wx.SizerFlags return the
wx.SizerFlags object itself allowing chaining multiple method calls
like in the examples above.", "");
class wxSizerFlags
{
public:
// construct the flags object initialized with the given proportion (0 by
// default)
DocCtorStr(
wxSizerFlags(int proportion = 0),
"Constructs the flags object with the specified proportion.", "");
~wxSizerFlags();
// This typemap ensures that the returned object is the same
// Python instance as what was passed in as `self`, instead of
// creating a new proxy as SWIG would normally do.
%typemap(out) wxSizerFlags& { $result = $self; Py_INCREF($result); }
DocDeclStr(
wxSizerFlags& , Proportion(int proportion),
"Sets the item's proportion value.", "");
DocDeclStr(
wxSizerFlags& , Align(int alignment),
"Sets the item's alignment", "");
DocDeclStr(
wxSizerFlags& , Expand(),
"Sets the wx.EXPAND flag, which will cause the item to be expanded to
fill as much space as it is given by the sizer.", "");
DocDeclStr(
wxSizerFlags& , Centre(),
"Same as `Center` for those with an alternate dialect of English.", "");
DocDeclStr(
wxSizerFlags& , Center(),
"Sets the centering alignment flags.", "");
DocDeclStr(
wxSizerFlags& , Left(),
"Aligns the object to the left, a shortcut for calling
Align(wx.ALIGN_LEFT)", "");
DocDeclStr(
wxSizerFlags& , Right(),
"Aligns the object to the right, a shortcut for calling
Align(wx.ALIGN_RIGHT)", "");
DocDeclStr(
wxSizerFlags& , Top(),
"Aligns the object to the top of the available space, a shortcut for
calling Align(wx.ALIGN_TOP)", "");
DocDeclStr(
wxSizerFlags& , Bottom(),
"Aligns the object to the bottom of the available space, a shortcut for
calling Align(wx.ALIGN_BOTTOM)", "");
DocDeclStr(
wxSizerFlags& , Shaped(),
"Sets the wx.SHAPED flag.", "");
DocDeclStr(
wxSizerFlags& , FixedMinSize(),
"Sets the wx.FIXED_MINSIZE flag.", "");
%extend {
DocDeclStr(
wxSizerFlags& , Border(int direction=wxALL, int borderInPixels=-1),
"Sets the border of the item in the direction(s) or sides given by the
direction parameter. If the borderInPixels value is not given then
the default border size (see `GetDefaultBorder`) will be used.", "")
{
if (borderInPixels == -1)
return self->Border(direction);
else
return self->Border(direction, borderInPixels);
}
}
DocDeclStr(
wxSizerFlags& , DoubleBorder(int direction = wxALL),
"Sets the border in the given direction to twice the default border
size.", "");
DocDeclStr(
wxSizerFlags& , TripleBorder(int direction = wxALL),
"Sets the border in the given direction to three times the default
border size.", "");
DocDeclStr(
wxSizerFlags& , HorzBorder(),
"Sets the left and right borders to the default border size.", "");
DocDeclStr(
wxSizerFlags& , DoubleHorzBorder(),
"Sets the left and right borders to twice the default border size.", "");
// Clear the typemap
%typemap(out) wxSizerFlags& ;
DocDeclStr(
static int , GetDefaultBorder(),
"Returns the default border size used by the other border methods", "");
DocDeclStr(
int , GetProportion() const,
"Returns the proportion value to be used in the sizer item.", "");
DocDeclStr(
int , GetFlags() const,
"Returns the flags value to be used in the sizer item.", "");
DocDeclStr(
int , GetBorderInPixels() const,
"Returns the border value in pixels to be used in the sizer item.", "");
};
//---------------------------------------------------------------------------
DocStr(wxSizerItem, DocStr(wxSizerItem,
"The wx.SizerItem class is used to track the position, size and other "The wx.SizerItem class is used to track the position, size and other
attributes of each item managed by a `wx.Sizer`. It is not usually attributes of each item managed by a `wx.Sizer`. It is not usually
@@ -444,7 +593,7 @@ public:
- **sizer**: The (child-)sizer to be added to the sizer. This - **sizer**: The (child-)sizer to be added to the sizer. This
allows placing a child sizer in a sizer and thus to create allows placing a child sizer in a sizer and thus to create
hierarchies of sizers (typically a vertical box as the top hierarchies of sizers (for example a vertical box as the top
sizer and several horizontal boxes on the level beneath). sizer and several horizontal boxes on the level beneath).
- **size**: A `wx.Size` or a 2-element sequence of integers - **size**: A `wx.Size` or a 2-element sequence of integers
@@ -552,8 +701,34 @@ public:
return NULL; return NULL;
} }
// virtual wxSizerItem* AddSpacer(int size);
// virtual wxSizerItem* AddStretchSpacer(int prop = 1); DocAStr(AddF,
"AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem",
"Similar to `Add` but uses the `wx.SizerFlags` convenience class for
setting the various flags, options and borders.", "");
wxSizerItem* AddF(PyObject* item, wxSizerFlags& flags) {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
if ( info.sizer )
PyObject_SetAttrString(item,"thisown",Py_False);
wxPyEndBlockThreads(blocked);
// Now call the real Add method if a valid item type was found
if ( info.window )
return self->Add(info.window, flags);
else if ( info.sizer )
return self->Add(info.sizer, flags);
else if (info.gotSize)
return self->Add(info.size.GetWidth(), info.size.GetHeight(),
flags.GetProportion(),
flags.GetFlags(),
flags.GetBorderInPixels());
else
return NULL;
}
DocAStr(Insert, DocAStr(Insert,
"Insert(self, int before, item, int proportion=0, int flag=0, int border=0, "Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
@@ -586,8 +761,35 @@ the item at index *before*. See `Add` for a description of the parameters.", ""
} }
// virtual wxSizerItem* InsertSpacer(size_t index, int size);
// virtual wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1); DocAStr(InsertF,
"InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem",
"Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.", "");
wxSizerItem* InsertF(int before, PyObject* item, wxSizerFlags& flags) {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
if ( info.sizer )
PyObject_SetAttrString(item,"thisown",Py_False);
wxPyEndBlockThreads(blocked);
// Now call the real Insert method if a valid item type was found
if ( info.window )
return self->Insert(before, info.window, flags);
else if ( info.sizer )
return self->Insert(before, info.sizer, flags);
else if (info.gotSize)
return self->Insert(before, info.size.GetWidth(), info.size.GetHeight(),
flags.GetProportion(),
flags.GetFlags(),
flags.GetBorderInPixels());
else
return NULL;
}
DocAStr(Prepend, DocAStr(Prepend,
"Prepend(self, item, int proportion=0, int flag=0, int border=0, "Prepend(self, item, int proportion=0, int flag=0, int border=0,
@@ -619,8 +821,34 @@ this sizer. See `Add` for a description of the parameters.", "");
return NULL; return NULL;
} }
// virtual wxSizerItem* PrependSpacer(int size);
// virtual wxSizerItem* PrependStretchSpacer(int prop = 1);
DocAStr(PrependF,
"PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem",
"Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.", "");
wxSizerItem* PrependF(PyObject* item, wxSizerFlags& flags) {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
if ( info.sizer )
PyObject_SetAttrString(item,"thisown",Py_False);
wxPyEndBlockThreads(blocked);
// Now call the real Add method if a valid item type was found
if ( info.window )
return self->Prepend(info.window, flags);
else if ( info.sizer )
return self->Prepend(info.sizer, flags);
else if (info.gotSize)
return self->Prepend(info.size.GetWidth(), info.size.GetHeight(),
flags.GetProportion(),
flags.GetFlags(),
flags.GetBorderInPixels());
else
return NULL;
}
DocAStr(Remove, DocAStr(Remove,

View File

@@ -11570,6 +11570,222 @@ _core_.ControlWithItems_swigregister(ControlWithItems)
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
class SizerFlags(object):
"""
Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
to specify a lot of flags and parameters which can be unwieldy. This
is where wx.SizerFlags comes in: it allows you to specify all
parameters using the named methods instead. For example, instead of::
sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
you can now write::
sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(10))
This is more readable and also allows you to create wx.SizerFlags
objects which can be reused for several sizer items.::
flagsExpand = wx.SizerFlags(1)
flagsExpand.Expand().Border(10)
sizer.AddF(ctrl1, flagsExpand)
sizer.AddF(ctrl2, flagsExpand)
Note that by specification, all methods of wx.SizerFlags return the
wx.SizerFlags object itself allowing chaining multiple method calls
like in the examples above.
"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args, **kwargs):
"""
__init__(self, int proportion=0) -> SizerFlags
Constructs the flags object with the specified proportion.
"""
_core_.SizerFlags_swiginit(self,_core_.new_SizerFlags(*args, **kwargs))
__swig_destroy__ = _core_.delete_SizerFlags
__del__ = lambda self : None;
def Proportion(*args, **kwargs):
"""
Proportion(self, int proportion) -> SizerFlags
Sets the item's proportion value.
"""
return _core_.SizerFlags_Proportion(*args, **kwargs)
def Align(*args, **kwargs):
"""
Align(self, int alignment) -> SizerFlags
Sets the item's alignment
"""
return _core_.SizerFlags_Align(*args, **kwargs)
def Expand(*args, **kwargs):
"""
Expand(self) -> SizerFlags
Sets the wx.EXPAND flag, which will cause the item to be expanded to
fill as much space as it is given by the sizer.
"""
return _core_.SizerFlags_Expand(*args, **kwargs)
def Centre(*args, **kwargs):
"""
Centre(self) -> SizerFlags
Same as `Center` for those with an alternate dialect of English.
"""
return _core_.SizerFlags_Centre(*args, **kwargs)
def Center(*args, **kwargs):
"""
Center(self) -> SizerFlags
Sets the centering alignment flags.
"""
return _core_.SizerFlags_Center(*args, **kwargs)
def Left(*args, **kwargs):
"""
Left(self) -> SizerFlags
Aligns the object to the left, a shortcut for calling
Align(wx.ALIGN_LEFT)
"""
return _core_.SizerFlags_Left(*args, **kwargs)
def Right(*args, **kwargs):
"""
Right(self) -> SizerFlags
Aligns the object to the right, a shortcut for calling
Align(wx.ALIGN_RIGHT)
"""
return _core_.SizerFlags_Right(*args, **kwargs)
def Top(*args, **kwargs):
"""
Top(self) -> SizerFlags
Aligns the object to the top of the available space, a shortcut for
calling Align(wx.ALIGN_TOP)
"""
return _core_.SizerFlags_Top(*args, **kwargs)
def Bottom(*args, **kwargs):
"""
Bottom(self) -> SizerFlags
Aligns the object to the bottom of the available space, a shortcut for
calling Align(wx.ALIGN_BOTTOM)
"""
return _core_.SizerFlags_Bottom(*args, **kwargs)
def Shaped(*args, **kwargs):
"""
Shaped(self) -> SizerFlags
Sets the wx.SHAPED flag.
"""
return _core_.SizerFlags_Shaped(*args, **kwargs)
def FixedMinSize(*args, **kwargs):
"""
FixedMinSize(self) -> SizerFlags
Sets the wx.FIXED_MINSIZE flag.
"""
return _core_.SizerFlags_FixedMinSize(*args, **kwargs)
def Border(*args, **kwargs):
"""
Border(self, int direction=ALL, int borderInPixels=-1) -> SizerFlags
Sets the border of the item in the direction(s) or sides given by the
direction parameter. If the borderInPixels value is not given then
the default border size (see `GetDefaultBorder`) will be used.
"""
return _core_.SizerFlags_Border(*args, **kwargs)
def DoubleBorder(*args, **kwargs):
"""
DoubleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to twice the default border
size.
"""
return _core_.SizerFlags_DoubleBorder(*args, **kwargs)
def TripleBorder(*args, **kwargs):
"""
TripleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to three times the default
border size.
"""
return _core_.SizerFlags_TripleBorder(*args, **kwargs)
def HorzBorder(*args, **kwargs):
"""
HorzBorder(self) -> SizerFlags
Sets the left and right borders to the default border size.
"""
return _core_.SizerFlags_HorzBorder(*args, **kwargs)
def DoubleHorzBorder(*args, **kwargs):
"""
DoubleHorzBorder(self) -> SizerFlags
Sets the left and right borders to twice the default border size.
"""
return _core_.SizerFlags_DoubleHorzBorder(*args, **kwargs)
def GetDefaultBorder(*args, **kwargs):
"""
GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args, **kwargs)
GetDefaultBorder = staticmethod(GetDefaultBorder)
def GetProportion(*args, **kwargs):
"""
GetProportion(self) -> int
Returns the proportion value to be used in the sizer item.
"""
return _core_.SizerFlags_GetProportion(*args, **kwargs)
def GetFlags(*args, **kwargs):
"""
GetFlags(self) -> int
Returns the flags value to be used in the sizer item.
"""
return _core_.SizerFlags_GetFlags(*args, **kwargs)
def GetBorderInPixels(*args, **kwargs):
"""
GetBorderInPixels(self) -> int
Returns the border value in pixels to be used in the sizer item.
"""
return _core_.SizerFlags_GetBorderInPixels(*args, **kwargs)
_core_.SizerFlags_swigregister(SizerFlags)
def SizerFlags_GetDefaultBorder(*args):
"""
SizerFlags_GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args)
class SizerItem(Object): class SizerItem(Object):
""" """
The wx.SizerItem class is used to track the position, size and other The wx.SizerItem class is used to track the position, size and other
@@ -11965,6 +12181,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Add(*args, **kwargs) return _core_.Sizer_Add(*args, **kwargs)
def AddF(*args, **kwargs):
"""
AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Add` but uses the `wx.SizerFlags` convenience class for
setting the various flags, options and borders.
"""
return _core_.Sizer_AddF(*args, **kwargs)
def Insert(*args, **kwargs): def Insert(*args, **kwargs):
""" """
Insert(self, int before, item, int proportion=0, int flag=0, int border=0, Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
@@ -11975,6 +12200,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Insert(*args, **kwargs) return _core_.Sizer_Insert(*args, **kwargs)
def InsertF(*args, **kwargs):
"""
InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_InsertF(*args, **kwargs)
def Prepend(*args, **kwargs): def Prepend(*args, **kwargs):
""" """
Prepend(self, item, int proportion=0, int flag=0, int border=0, Prepend(self, item, int proportion=0, int flag=0, int border=0,
@@ -11985,6 +12219,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Prepend(*args, **kwargs) return _core_.Sizer_Prepend(*args, **kwargs)
def PrependF(*args, **kwargs):
"""
PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_PrependF(*args, **kwargs)
def Remove(*args, **kwargs): def Remove(*args, **kwargs):
""" """
Remove(self, item) -> bool Remove(self, item) -> bool

File diff suppressed because it is too large Load Diff

View File

@@ -11570,6 +11570,222 @@ _core_.ControlWithItems_swigregister(ControlWithItems)
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
class SizerFlags(object):
"""
Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
to specify a lot of flags and parameters which can be unwieldy. This
is where wx.SizerFlags comes in: it allows you to specify all
parameters using the named methods instead. For example, instead of::
sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
you can now write::
sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(10))
This is more readable and also allows you to create wx.SizerFlags
objects which can be reused for several sizer items.::
flagsExpand = wx.SizerFlags(1)
flagsExpand.Expand().Border(10)
sizer.AddF(ctrl1, flagsExpand)
sizer.AddF(ctrl2, flagsExpand)
Note that by specification, all methods of wx.SizerFlags return the
wx.SizerFlags object itself allowing chaining multiple method calls
like in the examples above.
"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args, **kwargs):
"""
__init__(self, int proportion=0) -> SizerFlags
Constructs the flags object with the specified proportion.
"""
_core_.SizerFlags_swiginit(self,_core_.new_SizerFlags(*args, **kwargs))
__swig_destroy__ = _core_.delete_SizerFlags
__del__ = lambda self : None;
def Proportion(*args, **kwargs):
"""
Proportion(self, int proportion) -> SizerFlags
Sets the item's proportion value.
"""
return _core_.SizerFlags_Proportion(*args, **kwargs)
def Align(*args, **kwargs):
"""
Align(self, int alignment) -> SizerFlags
Sets the item's alignment
"""
return _core_.SizerFlags_Align(*args, **kwargs)
def Expand(*args, **kwargs):
"""
Expand(self) -> SizerFlags
Sets the wx.EXPAND flag, which will cause the item to be expanded to
fill as much space as it is given by the sizer.
"""
return _core_.SizerFlags_Expand(*args, **kwargs)
def Centre(*args, **kwargs):
"""
Centre(self) -> SizerFlags
Same as `Center` for those with an alternate dialect of English.
"""
return _core_.SizerFlags_Centre(*args, **kwargs)
def Center(*args, **kwargs):
"""
Center(self) -> SizerFlags
Sets the centering alignment flags.
"""
return _core_.SizerFlags_Center(*args, **kwargs)
def Left(*args, **kwargs):
"""
Left(self) -> SizerFlags
Aligns the object to the left, a shortcut for calling
Align(wx.ALIGN_LEFT)
"""
return _core_.SizerFlags_Left(*args, **kwargs)
def Right(*args, **kwargs):
"""
Right(self) -> SizerFlags
Aligns the object to the right, a shortcut for calling
Align(wx.ALIGN_RIGHT)
"""
return _core_.SizerFlags_Right(*args, **kwargs)
def Top(*args, **kwargs):
"""
Top(self) -> SizerFlags
Aligns the object to the top of the available space, a shortcut for
calling Align(wx.ALIGN_TOP)
"""
return _core_.SizerFlags_Top(*args, **kwargs)
def Bottom(*args, **kwargs):
"""
Bottom(self) -> SizerFlags
Aligns the object to the bottom of the available space, a shortcut for
calling Align(wx.ALIGN_BOTTOM)
"""
return _core_.SizerFlags_Bottom(*args, **kwargs)
def Shaped(*args, **kwargs):
"""
Shaped(self) -> SizerFlags
Sets the wx.SHAPED flag.
"""
return _core_.SizerFlags_Shaped(*args, **kwargs)
def FixedMinSize(*args, **kwargs):
"""
FixedMinSize(self) -> SizerFlags
Sets the wx.FIXED_MINSIZE flag.
"""
return _core_.SizerFlags_FixedMinSize(*args, **kwargs)
def Border(*args, **kwargs):
"""
Border(self, int direction=ALL, int borderInPixels=-1) -> SizerFlags
Sets the border of the item in the direction(s) or sides given by the
direction parameter. If the borderInPixels value is not given then
the default border size (see `GetDefaultBorder`) will be used.
"""
return _core_.SizerFlags_Border(*args, **kwargs)
def DoubleBorder(*args, **kwargs):
"""
DoubleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to twice the default border
size.
"""
return _core_.SizerFlags_DoubleBorder(*args, **kwargs)
def TripleBorder(*args, **kwargs):
"""
TripleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to three times the default
border size.
"""
return _core_.SizerFlags_TripleBorder(*args, **kwargs)
def HorzBorder(*args, **kwargs):
"""
HorzBorder(self) -> SizerFlags
Sets the left and right borders to the default border size.
"""
return _core_.SizerFlags_HorzBorder(*args, **kwargs)
def DoubleHorzBorder(*args, **kwargs):
"""
DoubleHorzBorder(self) -> SizerFlags
Sets the left and right borders to twice the default border size.
"""
return _core_.SizerFlags_DoubleHorzBorder(*args, **kwargs)
def GetDefaultBorder(*args, **kwargs):
"""
GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args, **kwargs)
GetDefaultBorder = staticmethod(GetDefaultBorder)
def GetProportion(*args, **kwargs):
"""
GetProportion(self) -> int
Returns the proportion value to be used in the sizer item.
"""
return _core_.SizerFlags_GetProportion(*args, **kwargs)
def GetFlags(*args, **kwargs):
"""
GetFlags(self) -> int
Returns the flags value to be used in the sizer item.
"""
return _core_.SizerFlags_GetFlags(*args, **kwargs)
def GetBorderInPixels(*args, **kwargs):
"""
GetBorderInPixels(self) -> int
Returns the border value in pixels to be used in the sizer item.
"""
return _core_.SizerFlags_GetBorderInPixels(*args, **kwargs)
_core_.SizerFlags_swigregister(SizerFlags)
def SizerFlags_GetDefaultBorder(*args):
"""
SizerFlags_GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args)
class SizerItem(Object): class SizerItem(Object):
""" """
The wx.SizerItem class is used to track the position, size and other The wx.SizerItem class is used to track the position, size and other
@@ -11965,6 +12181,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Add(*args, **kwargs) return _core_.Sizer_Add(*args, **kwargs)
def AddF(*args, **kwargs):
"""
AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Add` but uses the `wx.SizerFlags` convenience class for
setting the various flags, options and borders.
"""
return _core_.Sizer_AddF(*args, **kwargs)
def Insert(*args, **kwargs): def Insert(*args, **kwargs):
""" """
Insert(self, int before, item, int proportion=0, int flag=0, int border=0, Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
@@ -11975,6 +12200,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Insert(*args, **kwargs) return _core_.Sizer_Insert(*args, **kwargs)
def InsertF(*args, **kwargs):
"""
InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_InsertF(*args, **kwargs)
def Prepend(*args, **kwargs): def Prepend(*args, **kwargs):
""" """
Prepend(self, item, int proportion=0, int flag=0, int border=0, Prepend(self, item, int proportion=0, int flag=0, int border=0,
@@ -11985,6 +12219,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Prepend(*args, **kwargs) return _core_.Sizer_Prepend(*args, **kwargs)
def PrependF(*args, **kwargs):
"""
PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_PrependF(*args, **kwargs)
def Remove(*args, **kwargs): def Remove(*args, **kwargs):
""" """
Remove(self, item) -> bool Remove(self, item) -> bool

File diff suppressed because it is too large Load Diff

View File

@@ -11574,6 +11574,222 @@ _core_.ControlWithItems_swigregister(ControlWithItems)
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
class SizerFlags(object):
"""
Normally, when you add an item to a sizer via `wx.Sizer.Add`, you have
to specify a lot of flags and parameters which can be unwieldy. This
is where wx.SizerFlags comes in: it allows you to specify all
parameters using the named methods instead. For example, instead of::
sizer.Add(ctrl, 0, wx.EXPAND | wx.ALL, 10)
you can now write::
sizer.AddF(ctrl, wx.SizerFlags().Expand().Border(10))
This is more readable and also allows you to create wx.SizerFlags
objects which can be reused for several sizer items.::
flagsExpand = wx.SizerFlags(1)
flagsExpand.Expand().Border(10)
sizer.AddF(ctrl1, flagsExpand)
sizer.AddF(ctrl2, flagsExpand)
Note that by specification, all methods of wx.SizerFlags return the
wx.SizerFlags object itself allowing chaining multiple method calls
like in the examples above.
"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args, **kwargs):
"""
__init__(self, int proportion=0) -> SizerFlags
Constructs the flags object with the specified proportion.
"""
_core_.SizerFlags_swiginit(self,_core_.new_SizerFlags(*args, **kwargs))
__swig_destroy__ = _core_.delete_SizerFlags
__del__ = lambda self : None;
def Proportion(*args, **kwargs):
"""
Proportion(self, int proportion) -> SizerFlags
Sets the item's proportion value.
"""
return _core_.SizerFlags_Proportion(*args, **kwargs)
def Align(*args, **kwargs):
"""
Align(self, int alignment) -> SizerFlags
Sets the item's alignment
"""
return _core_.SizerFlags_Align(*args, **kwargs)
def Expand(*args, **kwargs):
"""
Expand(self) -> SizerFlags
Sets the wx.EXPAND flag, which will cause the item to be expanded to
fill as much space as it is given by the sizer.
"""
return _core_.SizerFlags_Expand(*args, **kwargs)
def Centre(*args, **kwargs):
"""
Centre(self) -> SizerFlags
Same as `Center` for those with an alternate dialect of English.
"""
return _core_.SizerFlags_Centre(*args, **kwargs)
def Center(*args, **kwargs):
"""
Center(self) -> SizerFlags
Sets the centering alignment flags.
"""
return _core_.SizerFlags_Center(*args, **kwargs)
def Left(*args, **kwargs):
"""
Left(self) -> SizerFlags
Aligns the object to the left, a shortcut for calling
Align(wx.ALIGN_LEFT)
"""
return _core_.SizerFlags_Left(*args, **kwargs)
def Right(*args, **kwargs):
"""
Right(self) -> SizerFlags
Aligns the object to the right, a shortcut for calling
Align(wx.ALIGN_RIGHT)
"""
return _core_.SizerFlags_Right(*args, **kwargs)
def Top(*args, **kwargs):
"""
Top(self) -> SizerFlags
Aligns the object to the top of the available space, a shortcut for
calling Align(wx.ALIGN_TOP)
"""
return _core_.SizerFlags_Top(*args, **kwargs)
def Bottom(*args, **kwargs):
"""
Bottom(self) -> SizerFlags
Aligns the object to the bottom of the available space, a shortcut for
calling Align(wx.ALIGN_BOTTOM)
"""
return _core_.SizerFlags_Bottom(*args, **kwargs)
def Shaped(*args, **kwargs):
"""
Shaped(self) -> SizerFlags
Sets the wx.SHAPED flag.
"""
return _core_.SizerFlags_Shaped(*args, **kwargs)
def FixedMinSize(*args, **kwargs):
"""
FixedMinSize(self) -> SizerFlags
Sets the wx.FIXED_MINSIZE flag.
"""
return _core_.SizerFlags_FixedMinSize(*args, **kwargs)
def Border(*args, **kwargs):
"""
Border(self, int direction=ALL, int borderInPixels=-1) -> SizerFlags
Sets the border of the item in the direction(s) or sides given by the
direction parameter. If the borderInPixels value is not given then
the default border size (see `GetDefaultBorder`) will be used.
"""
return _core_.SizerFlags_Border(*args, **kwargs)
def DoubleBorder(*args, **kwargs):
"""
DoubleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to twice the default border
size.
"""
return _core_.SizerFlags_DoubleBorder(*args, **kwargs)
def TripleBorder(*args, **kwargs):
"""
TripleBorder(self, int direction=ALL) -> SizerFlags
Sets the border in the given direction to three times the default
border size.
"""
return _core_.SizerFlags_TripleBorder(*args, **kwargs)
def HorzBorder(*args, **kwargs):
"""
HorzBorder(self) -> SizerFlags
Sets the left and right borders to the default border size.
"""
return _core_.SizerFlags_HorzBorder(*args, **kwargs)
def DoubleHorzBorder(*args, **kwargs):
"""
DoubleHorzBorder(self) -> SizerFlags
Sets the left and right borders to twice the default border size.
"""
return _core_.SizerFlags_DoubleHorzBorder(*args, **kwargs)
def GetDefaultBorder(*args, **kwargs):
"""
GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args, **kwargs)
GetDefaultBorder = staticmethod(GetDefaultBorder)
def GetProportion(*args, **kwargs):
"""
GetProportion(self) -> int
Returns the proportion value to be used in the sizer item.
"""
return _core_.SizerFlags_GetProportion(*args, **kwargs)
def GetFlags(*args, **kwargs):
"""
GetFlags(self) -> int
Returns the flags value to be used in the sizer item.
"""
return _core_.SizerFlags_GetFlags(*args, **kwargs)
def GetBorderInPixels(*args, **kwargs):
"""
GetBorderInPixels(self) -> int
Returns the border value in pixels to be used in the sizer item.
"""
return _core_.SizerFlags_GetBorderInPixels(*args, **kwargs)
_core_.SizerFlags_swigregister(SizerFlags)
def SizerFlags_GetDefaultBorder(*args):
"""
SizerFlags_GetDefaultBorder() -> int
Returns the default border size used by the other border methods
"""
return _core_.SizerFlags_GetDefaultBorder(*args)
class SizerItem(Object): class SizerItem(Object):
""" """
The wx.SizerItem class is used to track the position, size and other The wx.SizerItem class is used to track the position, size and other
@@ -11969,6 +12185,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Add(*args, **kwargs) return _core_.Sizer_Add(*args, **kwargs)
def AddF(*args, **kwargs):
"""
AddF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Add` but uses the `wx.SizerFlags` convenience class for
setting the various flags, options and borders.
"""
return _core_.Sizer_AddF(*args, **kwargs)
def Insert(*args, **kwargs): def Insert(*args, **kwargs):
""" """
Insert(self, int before, item, int proportion=0, int flag=0, int border=0, Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
@@ -11979,6 +12204,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Insert(*args, **kwargs) return _core_.Sizer_Insert(*args, **kwargs)
def InsertF(*args, **kwargs):
"""
InsertF(self, int before, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Insert`, but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_InsertF(*args, **kwargs)
def Prepend(*args, **kwargs): def Prepend(*args, **kwargs):
""" """
Prepend(self, item, int proportion=0, int flag=0, int border=0, Prepend(self, item, int proportion=0, int flag=0, int border=0,
@@ -11989,6 +12223,15 @@ class Sizer(Object):
""" """
return _core_.Sizer_Prepend(*args, **kwargs) return _core_.Sizer_Prepend(*args, **kwargs)
def PrependF(*args, **kwargs):
"""
PrependF(self, item, wx.SizerFlags flags) -> wx.SizerItem
Similar to `Prepend` but uses the `wx.SizerFlags` convenience class
for setting the various flags, options and borders.
"""
return _core_.Sizer_PrependF(*args, **kwargs)
def Remove(*args, **kwargs): def Remove(*args, **kwargs):
""" """
Remove(self, item) -> bool Remove(self, item) -> bool

File diff suppressed because it is too large Load Diff