| Function |
Parameter Type |
Remark |
| .show(flag) |
true/false |
Shows the dialog window in modal (flag=true) or modalless mode (flag=false). |
| .title(s) |
string |
Sets the window's title. |
| .icon(fname) |
string |
Uses the image in the file as the windows's icon. Supported image
formats include ".ico", ".gif", ".xpm",
and ".xbm". |
| .fullscreen(flag) |
true/false |
Enables/disables the fullscreen mode of the window. |
| .menubar([s1, s2...]) |
strings |
Creates a menubar in the window, adds menus to the menu bar, and adds items
to menus. A new menu bar is always created the first time to call or for
a call with no argument. The first string will be the main menu name and
the rests will be menu items. If the first character of a item ">",
a sub-menu will be created with the next item as the sub-menu name and the
following items will be added to the sub-menu; if the first character of
a item is "<", the following items will be added to the main
menu; and if the first character of a item is "_", a separator
bar will be added to the menu or sub-menu. |
| .toolbar(img, tip[, img, tip...]) |
strings |
Creates a toolbar in the window, adds image buttons and tips button-tips
to the toolbar bar. If the image file name is "|", a separator
bar will be added to the toolbar. Supported image formats include
".bmp", ".gif", ".xpm", ".jpg", ".png", ".tif", ".pcx", ".pnm", ".ico", "cur". |
| .statusbar(n) |
integer, string |
Creates a statusbar in the window. |
| .statusbar(n, s) |
integer, string |
Shows the string in the nth field of the statusbar. The first field
is 0. |
| Function |
Parameter Type |
Remark |
| .button(caption) |
string |
Creates a button control and returns the object. |
| .bitmap(fname[transparent, x, y]) |
string, boolean, integer, integer |
Fills the client area with the bitmap image. Supported image formats include
".bmp", ".gif", ".xpm", ".jpg", ".png", ".tif", ".pcx", ".pnm", ".ico", "cur". If the optional position parameters (x,y) are given, the image will not be stretched. |
| .bgcolor(r, g, b) |
integers |
Sets the background color of the window. A color value ranges from 0 to 255. |
| .checkbox(caption, checked) |
string, true/false |
Creates a checkbox control and returns the object. |
| .close() |
|
Usually called to close the main frame window. |
| .combobox(opt1, opt2[, ...]) |
strings |
Creates a combobox control and returns the object. |
| .cursor(type) |
string |
Sets window's cursor. The type parameter may be "arrow", "qarrow", "hand", "ibeam", "noentry", or "wait"; or a image file name. |
| .dialog([style]) |
true/false, string |
Creates a dialog box and returns it as user object,
which can call frame functions and may be casted to the base window
type for calling window functions. The style string can be parts of
the full style string "caption|resize|close|minimize|maximize|thick|no3d"
corresponding to styles of wxCAPTION | wxRESIZE_BORDER | wxCLOSE_BOX
| wxMINIMIZE_BOX | wxMAXIMIZE_BOX | wxTHICK_FRAME | wxSTAY_ON_TOP
| wxNO_3D. |
| .fgcolor(r, g, b) |
integers |
Sets the foreground color of the window. A color value ranges from 0 to 255. |
| .font(fnt) |
integer or array |
Sets font size if fnt is integer; otherwise sets font using data in the array returned from fontdialog() function. |
| .get() |
|
Gets the widget label as string. |
| .grid(rows, cols) |
integers |
Creates a grid control with the specified number of rows and columns. |
| .hwnd() |
|
Returns the window's handle as user object, which may be cast to HWND by other applications for painting. |
| .id() |
|
Returns the widget ID as integer. |
| .label(str) |
string |
Sets window's label. Sets text in case of text box. |
| .notebook(style) |
string |
Creates a notebook control and returns the object handle. The style may be "top", "left", "right", or "bottom". |
| .panel() |
|
Creates a panel and returns the object. |
| .push(func, event[, id]) |
string, string, integer/array |
Pushes an event handler on to the window's even handler stack. The
named function will be called when an event occurs. Refer to the event
table for what events will be handled by the handler for
widget IDs. An event may be "key", "mouse", "menu", or "tool". For "key" or "mouse" event, the id parameter is optional. |
| .radiobox(caption, style, opt1, opt2[, ...]) |
strings |
Creates a radiobox control and returns the object. If
the style="rows", option radio buttons will be arranged
in rows; otherwise in columns. |
| .size() |
|
Returns the size of the client area of a widget as an
array with width in [0] and height in [1]. |
| .size(w, h) |
integers |
Set the size of the client area of a widget. |
| .sizer(type) |
string |
Creates a horizontal (type="herbox") or vertical
(flag="verbox") box sizer in the widget. |
| .sizer(type, caption, width, height) |
string, string, integer, integer |
Creates a static horizontal (type="herstatic") or vertical
(flag="verstatic") box sizer in the widget. |
| .sizer("flexgrid", rows, rowgap, cols, colgap) |
string, integers |
Creates flex grid sizer in the widget. |
| .slider(style, value, min, max) |
string, integers |
Creates a slider control and returns the object. The
style may be "left" for vertical layout and label on the left, "right" for vertical layout and label on the right, "top" for horizontal layout and label on the top, or "bottom" for horizontal layout and label on the bottom. |
| .hsplitter([pos]) |
integer |
Creates a horizontal slitter control and returns the object, which
can call splitter functions. The optional parameter is for setting the initial split position. |
| .vsplitter([pos]) |
integer |
Creates a vertical slitter control and returns the object, which
can call splitter functions. The optional parameter is for setting the initial split position. |
| .statictext(text[, align]) |
string, integer |
Creates a static text (like a label) and returns the
object. The text will be right aligned if align>0; center aligned if align=0; and left aligned otherwise. |
| .style(style) |
string |
Sets the window style. The style string can be parts of the
full style string "simple|double|sunken|raised|static|none|vscroll|hscroll|clip"
corresponding to styles of wxSIMPLE_BORDER | DOUBLE_BORDER | wxSUNKEN_BORDER
| wxRAISED_BORDER | wxSTATIC_BORDER | wxNO_BORDER | wxVSCROLL | wxHSCROLL
| wxCLIP_CHILDREN. |
| .textbox(text[, style, width, height]); |
string, string, integer, integer |
Creates a textbox control and returns the object. The
style string can be parts of the full style string "multiline|password|readonly|left|center|right"
corresponding to styles of wxTE_MULTILINE | wxTE_PASSWORD | wxTE_READONLY
| wxTE_LEFT | wxTE_CENTRE | wxTE_RIGHT. |
| .textbox(text[, width, height]); |
string, integer, integer |
See above. |
| .treeview([func]); |
string |
Creates a treeview control and returns the object. The a
callback function name is provided, the function will be called with
the item text when the item is double clicked. |
| .user([object]); |
any |
Gets or sets (object specified) user object of the control. |
| Function |
Parameter Type |
Remark |
| .add(obj[, flag, prop]) |
user, string, integer |
Adds a window control or sizer to the sizer. The full optional flag string The full alignment string "top|bottom|left|right|all|expand|shaped|minsize|aligncenter|alignvertical|alignhorizontal|alignleft|alignright|aligntop|alignbottom"
corresponds to wxTOP | wxBOTTOM | wxLEFT | wxRIGHT | wxALL | wxEXPAND | wxSHAPED | wxFIXED_MINSIZE | wxALIGN_CENTER | wxALIGN_CENTER_VERTICAL | wxALIGN_CENTER_HORIZONTAL | wxALIGN_LEFT | wxALIGN_RIGHT wxALIGN_TOP | wxALIGN_BOTTOM; and the optional prop sets the proportion of space that control possesses in the sizer (box sizer only). |
| .add(width, height[, flag, prop]) |
integer, integer, string, integer |
Adds a spacer object to the sizer. |
| .sizer(type[, flag, prop]) |
string, string, integer |
Creates a horizontal (type="herbox") or vertical
(flag="verbox") box sizer in the sizer.
|
| .sizer(type, rows, rgap, cols, cgap[, flag, prop]) |
string, integer, integer integer integer, string, integer |
Creates a flexible grid (type="flexgrid") sizer in the sizer.
|
| .update() |
|
Updates layout of objects in the sizer.
|