[wxmax commit] r158 - trunk/wx.mod/wxwindow.mod
codesite...@google.com
Date: Wed Dec 12 11:24:36 2007
New Revision: 158
Modified:
trunk/wx.mod/wxwindow.mod/common.bmx
trunk/wx.mod/wxwindow.mod/glue.cpp
trunk/wx.mod/wxwindow.mod/glue.h
trunk/wx.mod/wxwindow.mod/wxwindow.bmx
Log:
Implemented more wxSizer methods, with documentation improvements.
Modified: trunk/wx.mod/wxwindow.mod/common.bmx
==============================================================================
--- trunk/wx.mod/wxwindow.mod/common.bmx (original)
+++ trunk/wx.mod/wxwindow.mod/common.bmx Wed Dec 12 11:24:36 2007
@@ -199,6 +199,16 @@
Function bmx_wxsizer_setitemminsize(handler:Byte Ptr, index:Int,
width:Int, height:Int)
Function bmx_wxsizer_setitemminsizewindow(handler:Byte Ptr,
window:Byte Ptr, width:Int, height:Int)
Function bmx_wxsizer_setitemminsizesizer(handler:Byte Ptr, sizer:Byte
Ptr, width:Int, height:Int)
+ Function bmx_wxsizer_clear(handler:Byte Ptr, deleteWindows:Int)
+ Function bmx_wxsizer_fitinside(handler:Byte Ptr, window:Byte Ptr)
+ Function bmx_wxsizer_getcontainingwindow:Byte Ptr(handler:Byte Ptr)
+ Function bmx_wxsizer_getsize(handler:Byte Ptr, w:Int Ptr, h:Int Ptr)
+ Function bmx_wxsizer_getposition(handler:Byte Ptr, x:Int Ptr, y:Int Ptr)
+ Function bmx_wxsizer_getminsize(handler:Byte Ptr, w:Int Ptr, h:Int Ptr)
+ Function bmx_wxsizer_setvirtualsizehints(handler:Byte Ptr,
window:Byte Ptr)
+ Function bmx_wxsizer_show:Int(handler:Byte Ptr, window:Byte Ptr,
doShow:Int, recursive:Int)
+ Function bmx_wxsizer_showsizer:Int(handler:Byte Ptr, sizer:Byte Ptr,
doShow:Int, recursive:Int)
+ Function bmx_wxsizer_showitem:Int(handler:Byte Ptr, index:Int, doShow:Int)
Function bmx_wxgridsizer_create:Byte Ptr(handle:Object, cols:Int,
vgap:Int, hgap:Int)
Function bmx_wxgridsizer_createrc:Byte Ptr(handle:Object, rows:Int,
cols:Int, vgap:Int, hgap:Int)
Function bmx_wxgridsizer_getcols:Int(handle:Byte Ptr)
@@ -215,6 +225,7 @@
Function bmx_wxflexgridsizer_addgrowablerow(handle:Byte Ptr,
index:Int, prop:Int)
Function bmx_wxsizer_fit(handle:Byte Ptr, window:Byte Ptr)
Function bmx_wxsizer_fitsize(handle:Byte Ptr, window:Byte Ptr, w:Int
Ptr, h:Int Ptr)
+ Function bmx_wxboxsizer_getorientation:Int(handle:Byte Ptr)
Function bmx_wxtooltip_enable(flag:Int)
Function bmx_wxtooltip_setdelay(msecs:Int)
Modified: trunk/wx.mod/wxwindow.mod/glue.cpp
==============================================================================
--- trunk/wx.mod/wxwindow.mod/glue.cpp (original)
+++ trunk/wx.mod/wxwindow.mod/glue.cpp Wed Dec 12 11:24:36 2007
@@ -705,6 +705,52 @@
sizer->SetItemMinSize(sz, width, height);
}
+void bmx_wxsizer_clear(wxSizer * sizer, bool deleteWindows) {
+ sizer->Clear(deleteWindows);
+}
+
+void bmx_wxsizer_fitinside(wxSizer * sizer, wxWindow * window) {
+ sizer->FitInside(window);
+}
+
+wxWindow * bmx_wxsizer_getcontainingwindow(wxSizer * sizer) {
+ return sizer->GetContainingWindow();
+}
+
+void bmx_wxsizer_getsize(wxSizer * sizer, int * w, int * h) {
+ wxSize s = sizer->GetSize();
+ *w = s.x;
+ *h = s.y;
+}
+
+void bmx_wxsizer_getposition(wxSizer * sizer, int * x, int * y) {
+ wxPoint p = sizer->GetPosition();
+ *x = p.x;
+ *y = p.y;
+}
+
+void bmx_wxsizer_getminsize(wxSizer * sizer, int * w, int * h) {
+ wxSize s = sizer->GetMinSize();
+ *w = s.x;
+ *h = s.y;
+}
+
+void bmx_wxsizer_setvirtualsizehints(wxSizer * sizer, wxWindow *
window) {
+ sizer->SetVirtualSizeHints(window);
+}
+
+bool bmx_wxsizer_show(wxSizer * sizer, wxWindow * window, bool doShow,
bool recursive) {
+ return sizer->Show(window, doShow, recursive);
+}
+
+bool bmx_wxsizer_showsizer(wxSizer * sizer, wxSizer * s, bool doShow,
bool recursive) {
+ return sizer->Show(s, doShow, recursive);
+}
+
+bool bmx_wxsizer_showitem(wxSizer * sizer, int index, bool doShow) {
+ return sizer->Show(index, doShow);
+}
+
MaxGridSizer * bmx_wxgridsizer_create(BBObject * maxHandle, int cols,
int vgap, int hgap) {
return new MaxGridSizer(maxHandle, cols, vgap, hgap);
}
@@ -769,6 +815,10 @@
wxSize s = sizer->Fit(window);
*w = s.x;
*h = s.y;
+}
+
+int bmx_wxboxsizer_getorientation(wxBoxSizer * sizer) {
+ return sizer->GetOrientation();
}
void bmx_wxtooltip_enable(bool flag) {
Modified: trunk/wx.mod/wxwindow.mod/glue.h
==============================================================================
--- trunk/wx.mod/wxwindow.mod/glue.h (original)
+++ trunk/wx.mod/wxwindow.mod/glue.h Wed Dec 12 11:24:36 2007
@@ -187,6 +187,16 @@
void bmx_wxsizer_setitemminsize(wxSizer * sizer, int index, int
width, int height);
void bmx_wxsizer_setitemminsizewindow(wxSizer * sizer, wxWindow *
window, int width, int height);
void bmx_wxsizer_setitemminsizesizer(wxSizer * sizer, wxSizer * sz,
int width, int height);
+ void bmx_wxsizer_clear(wxSizer * sizer, bool deleteWindows);
+ void bmx_wxsizer_fitinside(wxSizer * sizer, wxWindow * window);
+ wxWindow * bmx_wxsizer_getcontainingwindow(wxSizer * sizer);
+ void bmx_wxsizer_getsize(wxSizer * sizer, int * w, int * h);
+ void bmx_wxsizer_getposition(wxSizer * sizer, int * x, int * y);
+ void bmx_wxsizer_getminsize(wxSizer * sizer, int * w, int * h);
+ void bmx_wxsizer_setvirtualsizehints(wxSizer * sizer, wxWindow * window);
+ bool bmx_wxsizer_show(wxSizer * sizer, wxWindow * window, bool
doShow, bool recursive);
+ bool bmx_wxsizer_showsizer(wxSizer * sizer, wxSizer * s, bool doShow,
bool recursive);
+ bool bmx_wxsizer_showitem(wxSizer * sizer, int index, bool doShow);
MaxGridSizer * bmx_wxgridsizer_create(BBObject * maxHandle, int cols,
int vgap, int hgap);
MaxGridSizer * bmx_wxgridsizer_createrc(BBObject * maxHandle, int
rows, int cols, int vgap, int hgap);
int bmx_wxgridsizer_getcols(MaxGridSizer * sizer);
@@ -203,6 +213,7 @@
void bmx_wxflexgridsizer_addgrowablerow(MaxFlexGridSizer * sizer, int
index, int prop);
void bmx_wxsizer_fit(wxSizer * sizer, wxWindow * window);
void bmx_wxsizer_fitsize(wxSizer * sizer, wxWindow * window, int * w,
int * h);
+ int bmx_wxboxsizer_getorientation(wxBoxSizer * sizer);
void bmx_wxtooltip_enable(bool flag);
void bmx_wxtooltip_setdelay(long msecs);
Modified: trunk/wx.mod/wxwindow.mod/wxwindow.bmx
==============================================================================
--- trunk/wx.mod/wxwindow.mod/wxwindow.bmx (original)
+++ trunk/wx.mod/wxwindow.mod/wxwindow.bmx Wed Dec 12 11:24:36 2007
@@ -1646,21 +1646,30 @@
End Function
Rem
- bbdoc:
+ bbdoc: Appends a wxWindow to the sizer.
+ about: Its initial size (either set explicitly by the user or
calculated internally when
+ using default size (-1, -1)) is interpreted as the minimal and in
many cases also the initial size.
End Rem
Method Add:wxSizerItem(window:wxWindow, proportion:Int = 0, flag:Int
= 0, border:Int = 0)
Return wxSizerItem._create(bmx_wxsizer_add(wxSizerPtr,
window.wxObjectPtr, proportion, flag, border))
End Method
Rem
- bbdoc:
+ bbdoc: Appends a child-sizer to the sizer.
+ about: This allows placing a child sizer in a sizer and thus to
create hierarchies of sizers
+ (typically a vertical box as the top sizer and several horizontal
boxes on the level beneath).
End Rem
Method AddSizer:wxSizerItem(sizer:wxSizer, proportion:Int = 0,
flag:Int = 0, border:Int = 0)
Return wxSizerItem._create(bmx_wxsizer_addsizer(wxSizerPtr,
sizer.wxSizerPtr, proportion, flag, border))
End Method
Rem
- bbdoc:
+ bbdoc: Appends a custom spacer to the sizer.
+ about: Adding spacers to sizers gives more flexibility in the design
of dialogs; imagine for
+ example a horizontal box with two buttons at the bottom of a dialog:
you might want to insert a
+ space between the two buttons and make that space stretchable using
the proportion flag and the
+ result will be that the left button will be aligned with the left
side of the dialog and the
+ right button with the right side - the space in between will shrink
and grow with the dialog.
End Rem
Method AddCustomSpacer:wxSizerItem(width:Int, height:Int,
proportion:Int = 0, flag:Int = 0, border:Int = 0)
Return wxSizerItem._create(bmx_wxsizer_addcustomspacer(wxSizerPtr,
width, height, proportion, flag, border))
@@ -1682,10 +1691,18 @@
Return wxSizerItem._create(bmx_wxsizer_addstretchspacer(wxSizerPtr, proportion))
End Method
+ Rem
+ bbdoc: The sizer will do the actual calculation of its children
minimal sizes.
+ End Rem
Method CalcMin(w:Int Var, h:Int Var)
End Method
+ Rem
+ bbdoc: Detaches all children from the sizer.
+ about: If delete_windows is true then child windows will also be deleted.
+ End Rem
Method Clear(deleteWindows:Int = False)
+ bmx_wxsizer_clear(wxSizerPtr, deleteWindows)
End Method
Rem
@@ -1721,22 +1738,50 @@
bmx_wxsizer_fitsize(wxSizerPtr, window.wxObjectPtr, Varptr w, Varptr h)
End Method
+ Rem
+ bbdoc: Tell the sizer to resize the virtual size of the window to
match the sizer's minimal size.
+ about: 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.
+ End Rem
Method FitInside(window:wxWindow)
+ bmx_wxsizer_fitinside(wxSizerPtr, window.wxObjectPtr)
End Method
+ Rem
+ bbdoc: Returns the list of the items in this sizer.
+ End Rem
Method GetChildren()
End Method
+ Rem
+ bbdoc: Returns the window this sizer is used in or NULL if none.
+ End Rem
Method GetContainingWindow:wxWindow()
+ Return wxWindow._find(bmx_wxsizer_getcontainingwindow(wxSizerPtr))
End Method
+ Rem
+ bbdoc: Returns the current size of the sizer.
+ End Rem
Method GetSize(w:Int Var, h:Int Var)
+ bmx_wxsizer_getsize(wxSizerPtr, Varptr w, Varptr h)
End Method
+ Rem
+ bbdoc: Returns the current position of the sizer.
+ End Rem
Method GetPosition(x:Int Var, y:Int Var)
+ bmx_wxsizer_getposition(wxSizerPtr, Varptr x, Varptr y)
End Method
+ Rem
+ bbdoc: Returns the minimal size of the sizer.
+ about: 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.
+ End Rem
Method GetMinSize(w:Int Var, h:Int Var)
+ bmx_wxsizer_getminsize(wxSizerPtr, Varptr w, Varptr h)
End Method
Rem
@@ -1794,10 +1839,126 @@
bmx_wxsizer_setsizehints(wxSizerPtr, window.wxObjectPtr)
End Method
+ Rem
+ bbdoc: Tell the sizer to set the minimal size of the window virtual
area to match the sizer's minimal size.
+ about: For windows with managed scrollbars this will set them appropriately.
+ End Rem
+ Method SetVirtualSizeHints(window:wxWindow)
+ bmx_wxsizer_setvirtualsizehints(wxSizerPtr, window.wxObjectPtr)
+ End Method
+
+ Rem
+ bbdoc: Shows or hides the window.
+ returns: True if the child item was found, False otherwise.
+ about: To make a sizer item disappear or reappear, use Show()
followed by Layout(). Use parameter
+ recursive to show or hide elements found in subsizers.
+ End Rem
+ Method Show:Int(window:wxWindow, doShow:Int = True, recursive:Int = False)
+ Return bmx_wxsizer_show(wxSizerPtr, window.wxObjectPtr, doShow, recursive)
+ End Method
+
+ Rem
+ bbdoc: Shows or hides the sizer.
+ returns: True if the child item was found, False otherwise.
+ about: To make a sizer item disappear or reappear, use Show()
followed by Layout(). Use parameter
+ recursive to show or hide elements found in subsizers.
+ End Rem
+ Method ShowSizer:Int(sizer:wxSizer, doShow:Int = True, recursive:Int
= False)
+ Return bmx_wxsizer_showsizer(wxSizerPtr, sizer.wxSizerPtr, doShow, recursive)
+ End Method
+
+ Rem
+ bbdoc: Shows or hides the item at @index.
+ returns: True if the child item was found, False otherwise.
+ about: To make a sizer item disappear or reappear, use Show()
followed by Layout(). Use parameter
+ recursive to show or hide elements found in subsizers.
+ End Rem
+ Method ShowItem:Int(index:Int, doShow:Int = True)
+ Return bmx_wxsizer_showitem(wxSizerPtr, index, doShow)
+ End Method
+
End Type
Rem
-bbdoc:
+bbdoc: 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.
+about: As an example, we will construct a dialog that will contain a
text field at the top and two
+buttons at the bottom. This can be seen as a top-hierarchy column with
the text at the top and
+buttons at the bottom and a low-hierarchy row with an OK button to the
left and a Cancel button
+to the right. In many cases (particularly dialogs under Unix and
normal frames) the main window
+will be resizable by the user and this change of size will have to get
propagated to its children.
+In our case, we want the text area to grow with the dialog, whereas
the button shall have a fixed
+size. In addition, there will be a thin border around all controls to
make the dialog look nice and
+- to make matter worse - the buttons shall be centred as the width of
the dialog changes.
+<p>
+It is the unique feature of a box sizer, that it can grow in both
directions (height and width) but
+can distribute its growth in the main direction (horizontal for a row)
unevenly among its children.
+In our example case, the vertical sizer is supposed to propagate all
its height changes to only the
+text area, not to the button area. This is determined by the
proportion parameter when adding a
+window (or another sizer) to a sizer. It is interpreted as a weight
factor, i.e. it can be zero,
+indicating that the window may not be resized at all, or above zero.
If several windows have a value
+above zero, the value is interpreted relative to the sum of all weight
factors of the sizer, so when
+adding two windows with a value of 1, they will both get resized
equally much and each half as much
+as the sizer owning them. Then what do we do when a column sizer
changes its width? This behaviour
+is controlled by flags (the second parameter of the Add() function):
Zero or no flag indicates that
+the window will preserve it is original size, wxGROW flag (same as
wxEXPAND) forces the window to
+grow with the sizer, and wxSHAPED flag tells the window to change it
is size proportionally,
+preserving original aspect ratio. When wxGROW flag is not used, the
item can be aligned within
+available space. wxALIGN_LEFT, wxALIGN_TOP, wxALIGN_RIGHT,
wxALIGN_BOTTOM, wxALIGN_CENTER_HORIZONTAL
+and wxALIGN_CENTER_VERTICAL do what they say. wxALIGN_CENTRE (same as
wxALIGN_CENTER) is defined as
+(wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL). Default
alignment is wxALIGN_LEFT |
+wxALIGN_TOP.
+</p>
+<p>
+As mentioned above, any window belonging to a sizer may have border,
and it can be specified which
+of the four sides may have this border, using the wxTOP, wxLEFT,
wxRIGHT and wxBOTTOM constants or
+wxALL for all directions (and you may also use wxNORTH, wxWEST etc
instead). These flags can be used
+in combination with the alignment flags above as the second parameter
of the Add() method using the
+binary or operator |. The sizer of the border also must be made known,
and it is the third parameter
+in the Add() method. This means, that the entire behaviour of a sizer
and its children can be
+controlled by the three parameters of the Add() method.
+</p>
+<pre>
+' we want to get a dialog that is stretchable because it
+' has a text ctrl at the top and two buttons at the bottom
+Type MyDialog Extends wxDialog
+
+ Function CreateMyDialog:MyDialog(parent:wxFrame, id:Int, title:String)
+ Return New MyDialog.Create(parent, id, title, -1, -1, -1, -1,
wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
+ End Function
+
+ Method OnInit:Int()
+
+ Local topsizer:wxBoxSizer = New wxBoxSizer.Create( wxVERTICAL )
+ ' create text ctrl with minimal size 100x60
+ topsizer.Add( ..
+ New wxTextCtrl.Create( Self, -1, "My text.", -1, -1, 100, 60, wxTE_MULTILINE), ..
+ 1, .. ' make vertically stretchable
+ wxEXPAND | .. ' make horizontally stretchable
+ wxALL, .. ' and make border all around
+ 10 ) ' set border width to 10
+ Local button_sizer:wxBoxSizer = New wxBoxSizer.Create( wxHORIZONTAL )
+ button_sizer.Add( ..
+ New wxButton.Create( Self, wxID_OK, "OK" ), ..
+ 0, .. ' make horizontally unstretchable
+ wxALL, .. ' make border all around (implicit top alignment)
+ 10 ) ' set border width to 10
+ button_sizer.Add( ..
+ New wxButton.Create( Self, wxID_CANCEL, "Cancel" ), ..
+ 0, .. ' make horizontally unstretchable
+ wxALL, .. ' make border all around (implicit top alignment)
+ 10 ) ' set border width to 10
+ topsizer.AddSizer( ..
+ button_sizer, ..
+ 0, .. ' make vertically unstretchable
+ wxALIGN_CENTER ) ' no border and centre horizontally
+ SetSizer( topsizer ) ' use the sizer for layout
+ topsizer.SetSizeHints( Self ) ' set size hints to honour minimum size
+
+ Return True
+ End Method
+
+End Type
+</pre>
End Rem
Type wxBoxSizer Extends wxSizer
@@ -1811,17 +1972,38 @@
End Function
Rem
- bbdoc:
+ bbdoc: Creates a new wxBoxSizer.
+ about: @orient may be either of wxVERTICAL or wxHORIZONTAL for
creating either a column sizer
+ or a row sizer.
End Rem
Method Create:wxBoxSizer(orient:Int)
wxSizerPtr = bmx_wxboxsizer_create(Self, orient)
Return Self
End Method
+ ' Internal use only!
+ 'Method RecalcSizes()
+ ' bmx_wxboxsizer_recalcsizes(wxSizerPtr)
+ 'End Method
+
+ ' Internal use only!
+ 'Method CalcMin(w:Int Var, h:Int Var)
+ ' bmx_wxboxsizer_calcmin(wxSizerPtr, Varptr w, Varptr h)
+ 'End Method
+
+ Rem
+ bbdoc: Returns the orientation of the box sizer, either wxVERTICAL or wxHORIZONTAL.
+ End Rem
+ Method GetOrientation:Int()
+ Return bmx_wxboxsizer_getorientation(wxSizerPtr)
+ End Method
+
End Type
Rem
-bbdoc:
+bbdoc: wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a
static box around the sizer.
+about: 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.
End Rem
Type wxStatixBoxSizer Extends wxBoxSizer