nobody at rubyforge.org
2007-May-05 09:16 UTC
[Wxruby-development] [1012] trunk/wxruby2/doc/textile: Added docs for AUI Advanced User Interface classes
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!-- #msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; } #msg dt { float: left; width: 6em; font-weight: bold; } #msg dt:after { content:'':'';} #msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; } #msg dl a { font-weight: bold} #msg dl a:link { color:#fc3; } #msg dl a:active { color:#ff0; } #msg dl a:visited { color:#cc6; } h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; } #msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; } #msg ul, pre { overflow: auto; } #header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; } #patch { width: 100%; } #patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;} #patch .propset h4, #patch .binary h4 {margin:0;} #patch pre {padding:0;line-height:1.2em;margin:0;} #patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;} #patch .propset .diff, #patch .binary .diff {padding:10px 0;} #patch span {display:block;padding:0 10px;} #patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;} #patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;} #patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;} #patch .lines, .info {color:#888;background:#fff;} --></style> <title>[1012] trunk/wxruby2/doc/textile: Added docs for AUI Advanced User Interface classes</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>1012</dd> <dt>Author</dt> <dd>brokentoy</dd> <dt>Date</dt> <dd>2007-05-05 05:16:01 -0400 (Sat, 05 May 2007)</dd> </dl> <h3>Log Message</h3> <pre>Added docs for AUI Advanced User Interface classes</pre> <h3>Modified Paths</h3> <ul> <li><a href="#trunkwxruby2doctextileindextxtl">trunk/wxruby2/doc/textile/index.txtl</a></li> </ul> <h3>Added Paths</h3> <ul> <li><a href="#trunkwxruby2doctextileauidockarttxtl">trunk/wxruby2/doc/textile/auidockart.txtl</a></li> <li><a href="#trunkwxruby2doctextileauimanagertxtl">trunk/wxruby2/doc/textile/auimanager.txtl</a></li> <li><a href="#trunkwxruby2doctextileauinotebooktxtl">trunk/wxruby2/doc/textile/auinotebook.txtl</a></li> <li><a href="#trunkwxruby2doctextileauipaneinfotxtl">trunk/wxruby2/doc/textile/auipaneinfo.txtl</a></li> <li><a href="#trunkwxruby2doctextileauitabarttxtl">trunk/wxruby2/doc/textile/auitabart.txtl</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="trunkwxruby2doctextileauidockarttxtl"></a> <div class="addfile"><h4>Added: trunk/wxruby2/doc/textile/auidockart.txtl (0 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/auidockart.txtl         (rev 0) +++ trunk/wxruby2/doc/textile/auidockart.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -0,0 +1,203 @@ </span><ins>+h1(#wxauidockart). Wx::AuiDockArt + +AuiDockArt is part of the AUI class framework. +See also "AUI overview":auioverview.html. + +Dock art provider code - a dock provider provides all drawing +functionality to the Aui dock manager. This allows the dock +manager to have a plugable look-and-feel. + +By default, a "AuiManager":auimanager.html uses an +instance of this class called *AuiDefaultDockArt* which +provides bitmap art and a colour scheme that is adapted to +the major platforms'' look. You can either derive from that +class to alter its behaviour or write a completely new dock +art class. Call "AuiManager#set_art_provider":auimanager.html#AuiManager_setartprovider +to make use this new dock art. + +h2. Derived from + +No base class + +h2. See also + +"AuiManager":auimanager.html, +"AuiPaneInfo":auipaneinfo.html + +h2. Data structures + + + enum AuiPaneDockArtSetting + { + AUI_DOCKART_SASH_SIZE = 0, + AUI_DOCKART_CAPTION_SIZE = 1, + AUI_DOCKART_GRIPPER_SIZE = 2, + AUI_DOCKART_PANE_BORDER_SIZE = 3, + AUI_DOCKART_PANE_BUTTON_SIZE = 4, + AUI_DOCKART_BACKGROUND_COLOUR = 5, + AUI_DOCKART_SASH_COLOUR = 6, + AUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7, + AUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8, + AUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9, + AUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10, + AUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11, + AUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12, + AUI_DOCKART_BORDER_COLOUR = 13, + AUI_DOCKART_GRIPPER_COLOUR = 14, + AUI_DOCKART_CAPTION_FONT = 15, + AUI_DOCKART_GRADIENT_TYPE = 16 + } + + + + enum AuiPaneDockArtGradients + { + AUI_GRADIENT_NONE = 0, + AUI_GRADIENT_VERTICAL = 1, + AUI_GRADIENT_HORIZONTAL = 2 + } + + + + enum AuiPaneButtonState + { + AUI_BUTTON_STATE_NORMAL = 0, + AUI_BUTTON_STATE_HOVER = 1, + AUI_BUTTON_STATE_PRESSED = 2 + } + + + + enum AuiButtonId + { + AUI_BUTTON_CLOSE = 101, + AUI_BUTTON_MAXIMIZE_RESTORE = 102, + AUI_BUTTON_MINIMIZE = 103, + AUI_BUTTON_PIN = 104, + AUI_BUTTON_OPTIONS = 105, + AUI_BUTTON_WINDOWLIST = 106, + AUI_BUTTON_LEFT = 107, + AUI_BUTTON_RIGHT = 108, + AUI_BUTTON_UP = 109, + AUI_BUTTON_DOWN = 110, + AUI_BUTTON_CUSTOM1 = 201, + AUI_BUTTON_CUSTOM2 = 202, + AUI_BUTTON_CUSTOM3 = 203 + }; + + + + +h3(#AuiDockArt_wxauidockart). AuiDockArt.new + + *destructor*() + +Destructor. + +h3(#AuiDockArt_drawbackground). AuiDockArt#draw_background + + *draw_background*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)Integer% orientation, + %(arg-type)Rect% rect) + +Draws a background. + +h3(#AuiDockArt_drawborder). AuiDockArt#draw_border + + *draw_border*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)Rect% rect, + %(arg-type)AuiPaneInfo% pane) + +Draws a border. + +h3(#AuiDockArt_drawcaption). AuiDockArt#draw_caption + + *draw_caption*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)String% text, + %(arg-type)Rect% rect, + %(arg-type)AuiPaneInfo% pane) + +Draws a caption. + +h3(#AuiDockArt_drawgripper). AuiDockArt#draw_gripper + + *draw_gripper*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)Rect% rect, + %(arg-type)AuiPaneInfo% pane) + +Draws a gripper. + +h3(#AuiDockArt_drawpanebutton). AuiDockArt#draw_pane_button + + *draw_pane_button*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)Integer% button, + %(arg-type)Integer% button_state, + %(arg-type)Rect% rect, + %(arg-type)AuiPaneInfo% pane) + +Draws a button in the pane''s title bar. + +_button_ can be one of the values of *AuiButtonId*. + +_button_state_ can be one of the values of *AuiPaneButtonState*. + +h3(#AuiDockArt_drawsash). AuiDockArt#draw_sash + + *draw_sash*(%(arg-type)DC% dc, %(arg-type)Window% window, %(arg-type)Integer% orientation, + %(arg-type)Rect% rect) + +Draws a sash between two windows. + +h3(#AuiDockArt_getcolor). AuiDockArt#get_color + + "Colour":colour.html *get_color*(%(arg-type)Integer% id) + +The same as "get_colour":#AuiDockArt_getcolour. + +h3(#AuiDockArt_getcolour). AuiDockArt#get_colour + + "Colour":colour.html *get_colour*(%(arg-type)Integer% id) + +Get the colour of a certain setting. + +_id_ can be one of the colour values of *AuiPaneDockArtSetting*. + + +h3(#AuiDockArt_getfont). AuiDockArt#get_font + + "Font":font.html *get_font*(%(arg-type)Integer% id) + +Get a font setting. + +h3(#AuiDockArt_getmetric). AuiDockArt#get_metric + + Integer *get_metric*(%(arg-type)Integer% id) + +Get the value of a certain setting. + +_id_ can be one of the size values of *AuiPaneDockArtSetting*. + + +h3(#AuiDockArt_setcolor). AuiDockArt#set_color + + *set_color*(%(arg-type)Integer% id, %(arg-type)Colour% color) + +The same as "set_colour":#AuiDockArt_setcolour. + +h3(#AuiDockArt_setcolour). AuiDockArt#set_colour + + *set_colour*(%(arg-type)Integer% id, %(arg-type)Color% colour) + +Set a certain setting with the value _colour_. + +_id_ can be one of the colour values of *AuiPaneDockArtSetting*. + +h3(#AuiDockArt_setfont). AuiDockArt#set_font + + *set_font*(%(arg-type)Integer% id, %(arg-type)Font% font) + +Set a font setting. + +h3(#AuiDockArt_setmetric). AuiDockArt#set_metric + + *set_metric*(%(arg-type)Integer% id, %(arg-type)Integer% new_val) + +Set a certain setting with the value _new_val_. + +_id_ can be one of the size values of *AuiPaneDockArtSetting*. + </ins></span></pre></div> <a id="trunkwxruby2doctextileauimanagertxtl"></a> <div class="addfile"><h4>Added: trunk/wxruby2/doc/textile/auimanager.txtl (0 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/auimanager.txtl         (rev 0) +++ trunk/wxruby2/doc/textile/auimanager.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -0,0 +1,351 @@ </span><ins>+h1(#wxauimanager). Wx::AuiManager + +AuiManager is the central class of the AUI class framework. + +See also "AUI overview":auioverview.html. + +AuiManager manages the panes associated with it +for a particular Frame, using a pane''s AuiPaneInfo information to +determine each pane''s docking and floating behavior. AuiManager +uses Widgets'' sizer mechanism to plan the layout of each frame. It +uses a replaceable dock art class to do all drawing, so all drawing is +localized in one area, and may be customized depending on an +application''s specific needs. + +AuiManager works as follows: the programmer adds panes to the class, +or makes changes to existing pane properties (dock position, floating +state, show state, etc.). To apply these changes, AuiManager''s +Update() function is called. This batch processing can be used to avoid +flicker, by modifying more than one pane at a time, and then "committing" +all of the changes at once by calling Update(). + +Panes can be added quite easily: + + + TextCtrl* text1 = new TextCtrl(this, -1); + TextCtrl* text2 = new TextCtrl(this, -1); + m_mgr.AddPane(text1, LEFT, T("Pane Caption")); + m_mgr.AddPane(text2, BOTTOM, T("Pane Caption")); + m_mgr.Update(); + + +Later on, the positions can be modified easily. The following will float +an existing pane in a tool window: + + + m_mgr.GetPane(text1).Float(); + + +h2. Layers, Rows and Directions, Positions + +Inside AUI, the docking layout is figured out by checking several +pane parameters. Four of these are important for determining where a +pane will end up: + +*Direction:* +Each docked pane has a direction, Top, Bottom, Left, Right, or +Center. This is fairly self-explanatory. The pane will be placed in the +location specified by this variable. + +*Position:* +More than one pane can be placed inside of a dock. Imagine two panes +being docked on the left side of a window. One pane can be placed over +another. In proportionally managed docks, the pane position indicates +its sequential position, starting with zero. So, in our scenario with +two panes docked on the left side, the top pane in the dock would have +position 0, and the second one would occupy position 1. + +*Row:* +A row can allow for two docks to be placed next to each other. One of +the most common places for this to happen is in the toolbar. Multiple +toolbar rows are allowed, the first row being row 0, and the second +row 1. Rows can also be used on vertically docked panes. + +*Layer:* +A layer is akin to an onion. Layer 0 is the very center of the +managed pane. Thus, if a pane is in layer 0, it will be closest to the +center window (also sometimes known as the "content window"). +Increasing layers "swallow up" all layers of a lower value. This can +look very similar to multiple rows, but is different because all panes +in a lower level yield to panes in higher levels. The best way to +understand layers is by running the AUI sample. + +h2. Derived from + +"EvtHandler":evthandler.html + +h2. See also + +"AuiPaneInfo":auipaneinfo.html, +"AuiDockArt":auidockart.html + +h2. Data structures + + + enum AuiManagerDock + { + AUI_DOCK_NONE = 0, + AUI_DOCK_TOP = 1, + AUI_DOCK_RIGHT = 2, + AUI_DOCK_BOTTOM = 3, + AUI_DOCK_LEFT = 4, + AUI_DOCK_CENTER = 5, + AUI_DOCK_CENTRE = AUI_DOCK_CENTER + } + + + + enum AuiManagerOption + { + AUI_MGR_ALLOW_FLOATING = 1 << 0, + AUI_MGR_ALLOW_ACTIVE_PANE = 1 << 1, + AUI_MGR_TRANSPARENT_DRAG = 1 << 2, + AUI_MGR_TRANSPARENT_HINT = 1 << 3, + AUI_MGR_VENETIAN_BLINDS_HINT = 1 << 4, + AUI_MGR_RECTANGLE_HINT = 1 << 5, + AUI_MGR_HINT_FADE = 1 << 6, + AUI_MGR_NO_VENETIAN_BLINDS_FADE = 1 << 7, + + AUI_MGR_DEFAULT = AUI_MGR_ALLOW_FLOATING | + AUI_MGR_TRANSPARENT_HINT | + AUI_MGR_HINT_FADE | + AUI_MGR_NO_VENETIAN_BLINDS_FADE + } + + + +<div id="methods"> + +h2. Methods + +* "AuiManager.new":#AuiManager_new +* "AuiManager#add_pane":#AuiManager_addpane +* "AuiManager#detach_pane":#AuiManager_detachpane +* "AuiManager#get_all_panes":#AuiManager_getallpanes +* "AuiManager#get_art_provider":#AuiManager_getartprovider +* "AuiManager#get_dock_size_constraint":#AuiManager_getdocksizeconstraint +* "AuiManager#get_flags":#AuiManager_getflags +* "AuiManager#get_managed_window":#AuiManager_getmanagedwindow +* "AuiManager#get_manager":#AuiManager_getmanager +* "AuiManager#get_pane":#AuiManager_getpane +* "AuiManager#hide_hint":#AuiManager_hidehint +* "AuiManager#insert_pane":#AuiManager_insertpane +* "AuiManager#load_pane_info":#AuiManager_loadpaneinfo +* "AuiManager#load_perspective":#AuiManager_loadperspective +* "AuiManager#process_dock_result":#AuiManager_processdockresult +* "AuiManager#save_pane_info":#AuiManager_savepaneinfo +* "AuiManager#save_perspective":#AuiManager_saveperspective +* "AuiManager#set_art_provider":#AuiManager_setartprovider +* "AuiManager#set_dock_size_constraint":#AuiManager_setdocksizeconstraint +* "AuiManager#set_flags":#AuiManager_setflags +* "AuiManager#set_managed_window":#AuiManager_setmanagedwindow +* "AuiManager#show_hint":#AuiManager_showhint +* "AuiManager#un_init":#AuiManager_uninit +* "AuiManager#update":#AuiManager_update + +</div> + + + +h3(#AuiManager_wxauimanager). AuiManager.new + + *AuiManager.new*(%(arg-type)Window% managed_wnd = nil, + %(arg-type)unsigned int% flags = AUI_MGR_DEFAULT) + +Constructor. managed_wnd specifies the Frame which should be managed. +flags specifies options which allow the frame management behavior +to be modified. + + *destructor*() + +h3(#AuiManager_addpane). AuiManager#add_pane + + Boolean *add_pane*(%(arg-type)Window% window, %(arg-type)AuiPaneInfo% pane_info) + + Boolean *add_pane*(%(arg-type)Window% window, %(arg-type)Integer% direction = LEFT, + %(arg-type)String% caption = '''') + + Boolean *add_pane*(%(arg-type)Window% window, %(arg-type)AuiPaneInfo% pane_info, + %(arg-type)Point% drop_pos) + + +AddPane() tells the frame manager to start managing a child window. There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration. The last version allows a drop position to be specified, which will determine where the pane will be added. + +h3(#AuiManager_detachpane). AuiManager#detach_pane + + Boolean *detach_pane*(%(arg-type)Window% window) + +Tells the AuiManager to stop managing the pane specified by window. +The window, if in a floated frame, is reparented to the frame managed +by AuiManager. + +h3(#AuiManager_getallpanes). AuiManager#get_all_panes + + "AuiPaneInfoArray":auipaneinfoarray.html *get_all_panes*() + +Returns an array of all panes managed by the frame manager. + +h3(#AuiManager_getartprovider). AuiManager#get_art_provider + + "AuiDockArt":auidockart.html *get_art_provider*() + +Returns the current art provider being used. + +See also: "AuiDockArt":auidockart.html. + +h3(#AuiManager_getdocksizeconstraint). AuiManager#get_dock_size_constraint + + *get_dock_size_constraint*(%(arg-type)double% widthpct, %(arg-type)double% heightpct) + +Returns the current dock constraint values. See "set_dock_size_constraint()":#AuiManager_setdocksizeconstraint() for more information. + +h3(#AuiManager_getflags). AuiManager#get_flags + + unsigned int *get_flags*() + +Returns the current manager''s flags. + +h3(#AuiManager_getmanagedwindow). AuiManager#get_managed_window + + "Window":window.html *get_managed_window*() + +Returns the frame currently being managed by AuiManager. + +h3(#AuiManager_getmanager). AuiManager#get_manager + + "AuiManager":auimanager.html *get_manager*(%(arg-type)Window% window) + +Calling this method will return the AuiManager for a given window. The window parameter should +specify any child window or sub-child window of the frame or window managed by AuiManager. +The window parameter need not be managed by the manager itself, nor does it even need to be a child +or sub-child of a managed window. It must however be inside the window hierarchy underneath the managed +window. + +h3(#AuiManager_getpane). AuiManager#get_pane + + "AuiPaneInfo":auipaneinfo.html *get_pane*(%(arg-type)Window% window) + + "AuiPaneInfo":auipaneinfo.html *get_pane*(%(arg-type)String% name) + +_GetPane_ is used to lookup a AuiPaneInfo object +either by window pointer or by pane name, which acts as a unique id for +a window pane. The returned AuiPaneInfo object may then be modified to +change a pane''s look, state or position. After one or more +modifications to AuiPaneInfo, AuiManager::Update() should be called +to commit the changes to the user interface. If the lookup failed +(meaning the pane could not be found in the manager), a call to the +returned AuiPaneInfo''s IsOk() method will return false. + +h3(#AuiManager_hidehint). AuiManager#hide_hint + + *hide_hint*() + +HideHint() hides any docking hint that may be visible. + +h3(#AuiManager_insertpane). AuiManager#insert_pane + + Boolean *insert_pane*(%(arg-type)Window% window, %(arg-type)AuiPaneInfo% insert_location, + %(arg-type)Integer% insert_level = AUI_INSERT_PANE) + +This method is used to insert either a previously unmanaged pane window +into the frame manager, or to insert a currently managed pane somewhere +else. _InsertPane_ will push all panes, rows, or docks aside and +insert the window into the position specified by insert_location. +Because insert_location can specify either a pane, dock row, or dock +layer, the insert_level parameter is used to disambiguate this. The +parameter insert_level can take a value of AUI_INSERT_PANE, AUI_INSERT_ROW +or AUI_INSERT_DOCK. + +h3(#AuiManager_loadpaneinfo). AuiManager#load_pane_info + + *load_pane_info*(%(arg-type)String% pane_part, %(arg-type)AuiPaneInfo% pane) + +LoadPaneInfo() is similar to to LoadPerspective, with the exception that it only loads information about a single pane. It is used in combination with SavePaneInfo(). + +h3(#AuiManager_loadperspective). AuiManager#load_perspective + + Boolean *load_perspective*(%(arg-type)String% perspective, %(arg-type)Boolean% update = true) + +Loads a saved perspective. If update is true, AuiManager::Update() +is automatically invoked, thus realizing the saved perspective on screen. + +h3(#AuiManager_processdockresult). AuiManager#process_dock_result + + Boolean *process_dock_result*(%(arg-type)AuiPaneInfo% target, %(arg-type)AuiPaneInfo% new_pos) + +ProcessDockResult() is a protected member of the AUI layout manager. It can be overridden by derived classes to provide custom docking calculations. + +h3(#AuiManager_savepaneinfo). AuiManager#save_pane_info + + String *save_pane_info*(%(arg-type)AuiPaneInfo% pane) + +SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane. It is used in combination with LoadPaneInfo(). + +h3(#AuiManager_saveperspective). AuiManager#save_perspective + + String *save_perspective*() + +Saves the entire user interface layout into an encoded String, which +can then be stored by the application (probably using Config). When +a perspective is restored using LoadPerspective(), the entire user +interface will return to the state it was when the perspective was saved. + +h3(#AuiManager_setartprovider). AuiManager#set_art_provider + + *set_art_provider*(%(arg-type)AuiDockArt% art_provider) + +Instructs AuiManager to use art provider specified by parameter +art_provider for all drawing calls. This allows plugable +look-and-feel features. The previous art provider object, if any, +will be deleted by AuiManager. + +See also: "AuiDockArt":auidockart.html. + +h3(#AuiManager_setdocksizeconstraint). AuiManager#set_dock_size_constraint + + *set_dock_size_constraint*(%(arg-type)double% widthpct, %(arg-type)double% heightpct) + +When a user creates a new dock by dragging a window into a docked position, often times the large size of the +window will create a dock that is unwieldly large. AuiManager by default limits the size of any +new dock to 1/3 of the window size. For horizontal docks, this would be 1/3 of the window height. For +vertical docks, 1/3 of the width. Calling this function will adjust this constraint value. The numbers +must be between 0.0 and 1.0. For instance, calling SetDockSizeContraint with 0.5, 0.5 will cause new +docks to be limited to half of the size of the entire managed window. + +h3(#AuiManager_setflags). AuiManager#set_flags + + *set_flags*(%(arg-type)unsigned int% flags) + +This method is used to specify AuiManager''s settings flags. flags +specifies options which allow the frame management behavior to be modified. + +h3(#AuiManager_setmanagedwindow). AuiManager#set_managed_window + + *set_managed_window*(%(arg-type)Window% managed_wnd) + +Called to specify the frame or window which is to be managed by AuiManager. Frame management is not restricted to just frames. Child windows or custom controls are also allowed. + +h3(#AuiManager_showhint). AuiManager#show_hint + + *show_hint*(%(arg-type)Rect% rect) + +This function is used by controls to explicitly show a hint window at the specified rectangle. It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour. The specified rectangle should be in screen coordinates. + +h3(#AuiManager_uninit). AuiManager#un_init + + *un_init*() + +Uninitializes the framework and should be called before a managed frame or window is destroyed. UnInit() is usually called in the managed Frame''s destructor. It is necessary to call this function before the managed frame or window is destroyed, otherwise the manager cannot remove its custom event handlers from a window. + +h3(#AuiManager_update). AuiManager#update + + *update*() + +This method is called after any number of changes are +made to any of the managed panes. Update() must be invoked after +AddPane() or InsertPane() are called in order to "realize" or "commit" +the changes. In addition, any number of changes may be made to +AuiPaneInfo structures (retrieved with AuiManager::GetPane), but to +realize the changes, Update() must be called. This construction allows +pane flicker to be avoided by updating the whole layout at one time. + </ins></span></pre></div> <a id="trunkwxruby2doctextileauinotebooktxtl"></a> <div class="addfile"><h4>Added: trunk/wxruby2/doc/textile/auinotebook.txtl (0 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/auinotebook.txtl         (rev 0) +++ trunk/wxruby2/doc/textile/auinotebook.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -0,0 +1,211 @@ </span><ins>+h1(#wxauinotebook). Wx::AuiNotebook + +AuiNotebook is part of the AUI class framework. +See also "AUI overview":auioverview.html. + +AuiNotebook is a notebook control which implements many features common in applications with dockable panes. +Specifically, AuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop, +split the tab window into many different splitter configurations, and toggle through different themes to customize +the control''s look and feel. + +An effort has been made to try to maintain an API as similar to that of Notebook. + +The default theme that is used is AuiDefaultTabArt, which provides a modern, glossy look and feel. +The theme can be changed by calling "AuiNotebook#set_art_provider":auinotebook.html#AuiNotebook_setartprovider. + +h2. Derived from + +"Control":control.html + +h2. Window styles + + +|@AUI_NB_DEFAULT_STYLE@|Defined as AUI_NB_TOP | AUI_NB_TAB_SPLIT | AUI_NB_TAB_MOVE | AUI_NB_SCROLL_BUTTONS | AUI_NB_CLOSE_ON_ACTIVE_TAB.| +|@AUI_NB_TAB_SPLIT@|Allows the tab control to be split by dragging a tab.| +|@AUI_NB_TAB_MOVE@|Allows a tab to be moved horizontally by dragging.| +|@AUI_NB_TAB_EXTERNAL_MOVE@|Allows a tab to be moved to another tab control.| +|@AUI_NB_TAB_FIXED_WIDTH@|With this style, all tabs have the same width.| +|@AUI_NB_SCROLL_BUTTONS@|With this style, left and right scroll buttons are displayed.| +|@AUI_NB_WINDOWLIST_BUTTON@|With this style, a drop-down list of windows is available.| +|@AUI_NB_CLOSE_BUTTON@|With this style, a close button is available on the tab bar.| +|@AUI_NB_CLOSE_ON_ACTIVE_TAB@|With this style, the close button is visible on the active tab.| +|@AUI_NB_CLOSE_ON_ALL_TABS@|With this style, the close button is visible on all tabs.| + + + +h2. Data structures + +<div id="methods"> + +h2. Methods + +* "AuiNotebook.new":#AuiNotebook_new +* "AuiNotebook#add_page":#AuiNotebook_addpage +* "AuiNotebook#create":#AuiNotebook_create +* "AuiNotebook#delete_page":#AuiNotebook_deletepage +* "AuiNotebook#get_art_provider":#AuiNotebook_getartprovider +* "AuiNotebook#get_page":#AuiNotebook_getpage +* "AuiNotebook#get_page_bitmap":#AuiNotebook_getpagebitmap +* "AuiNotebook#get_page_count":#AuiNotebook_getpagecount +* "AuiNotebook#get_page_index":#AuiNotebook_getpageindex +* "AuiNotebook#get_page_text":#AuiNotebook_getpagetext +* "AuiNotebook#get_selection":#AuiNotebook_getselection +* "AuiNotebook#insert_page":#AuiNotebook_insertpage +* "AuiNotebook#remove_page":#AuiNotebook_removepage +* "AuiNotebook#set_art_provider":#AuiNotebook_setartprovider +* "AuiNotebook#set_page_bitmap":#AuiNotebook_setpagebitmap +* "AuiNotebook#set_page_text":#AuiNotebook_setpagetext +* "AuiNotebook#set_selection":#AuiNotebook_setselection +* "AuiNotebook#set_tab_ctrl_height":#AuiNotebook_settabctrlheight +* "AuiNotebook#set_uniform_bitmap_size":#AuiNotebook_setuniformbitmapsize + +</div> + + +h3(#AuiNotebook_wxauinotebook). AuiNotebook.new + + *AuiNotebook.new*(%(arg-type)Window% parent, %(arg-type)Integer% id = ID_ANY, + %(arg-type)Point% pos = DEFAULT_POSITION, + %(arg-type)Size% size = DEFAULT_SIZE, + %(arg-type)Integer% style = AUI_NB_DEFAULT_STYLE) + +Constructor. Creates a AuiNotebok control. + +h3(#AuiNotebook_addpage). AuiNotebook#add_page + + Boolean *add_page*(%(arg-type)Window% page, %(arg-type)String% caption, + %(arg-type)Boolean% select = false, + %(arg-type)Bitmap% bitmap = NullBitmap) + +Adds a page. If the _select_ parameter is true, calling this will generate a page change event. + +h3(#AuiNotebook_create). AuiNotebook#create + + Boolean *create*(%(arg-type)Window% parent, %(arg-type)Integer% id = ID_ANY, + %(arg-type)Point% pos = DEFAULT_POSITION, + %(arg-type)Size% size = DEFAULT_SIZE, + %(arg-type)Integer% style = 0) + +Creates the notebook window. + +h3(#AuiNotebook_deletepage). AuiNotebook#delete_page + + Boolean *delete_page*(%(arg-type)size_t% page) + +Deletes a page at the given index. Calling this method will generate a page change event. + +h3(#AuiNotebook_getartprovider). AuiNotebook#get_art_provider + + "AuiTabArt":auitabart.html *get_art_provider*() + +Returns the associated art provider. + +h3(#AuiNotebook_getpage). AuiNotebook#get_page + + "Window":window.html *get_page*(%(arg-type)size_t% page_idx) + +Returns the page specified by the given index. + +h3(#AuiNotebook_getpagebitmap). AuiNotebook#get_page_bitmap + + "Bitmap":bitmap.html *get_page_bitmap*(%(arg-type)size_t% page) + +Returns the tab bitmap for the page. + +h3(#AuiNotebook_getpagecount). AuiNotebook#get_page_count + + size_t *get_page_count*() + +Returns the number of pages in the notebook. + +h3(#AuiNotebook_getpageindex). AuiNotebook#get_page_index + + Integer *get_page_index*(%(arg-type)Window% page_wnd) + +Returns the page index for the specified window. If the window is not found in +the notebook, NOT_FOUND is returned. + +h3(#AuiNotebook_getpagetext). AuiNotebook#get_page_text + + String *get_page_text*(%(arg-type)size_t% page) + +Returns the tab label for the page. + +h3(#AuiNotebook_getselection). AuiNotebook#get_selection + + Integer *get_selection*() + +Returns the currently selected page. + +h3(#AuiNotebook_insertpage). AuiNotebook#insert_page + + Boolean *insert_page*(%(arg-type)size_t% page_idx, %(arg-type)Window% page, + %(arg-type)String% caption, + %(arg-type)Boolean% select = false, + %(arg-type)Bitmap% bitmap = NullBitmap) + +InsertPage() is similar to AddPage, but allows the ability to specify the insert location. +If the _select_ parameter is true, calling this will generate a page change event. + +h3(#AuiNotebook_removepage). AuiNotebook#remove_page + + Boolean *remove_page*(%(arg-type)size_t% page) + +Removes a page, without deleting the window pointer. + +h3(#AuiNotebook_setartprovider). AuiNotebook#set_art_provider + + *set_art_provider*(%(arg-type)AuiTabArt% art) + +Sets the art provider to be used by the notebook. + +h3(#AuiNotebook_setpagebitmap). AuiNotebook#set_page_bitmap + + Boolean *set_page_bitmap*(%(arg-type)size_t% page, %(arg-type)Bitmap% bitmap) + +Sets the bitmap for the page. To remove a bitmap from the tab caption, pass +NullBitmap. + +h3(#AuiNotebook_setpagetext). AuiNotebook#set_page_text + + Boolean *set_page_text*(%(arg-type)size_t% page, %(arg-type)String% text) + +Sets the tab label for the page. + +h3(#AuiNotebook_setselection). AuiNotebook#set_selection + + size_t *set_selection*(%(arg-type)size_t% new_page) + +Sets the page selection. Calling this method will generate a page change event. + +h3(#AuiNotebook_settabctrlheight). AuiNotebook#set_tab_ctrl_height + + *set_tab_ctrl_height*(%(arg-type)Integer% height) + +Sets the tab height. By default, the tab control height is calculated +by measuring the text height and bitmap sizes on the tab captions. Calling this +method will override that calculation and set the tab control to the specified +height parameter. A call to this method will override any call to SetUniformBitmapSize(). +Specifying -1 as the height will return the control to its default auto-sizing behaviour. + +h3(#AuiNotebook_setuniformbitmapsize). AuiNotebook#set_uniform_bitmap_size + + *set_uniform_bitmap_size*(%(arg-type)Size% size) + +SetUniformBitmapSize() ensures that all tabs will have the same height, even +if some tabs don''t have bitmaps. Passing DefaultSize to this function will +instruct the control to use dynamic tab height, which is the default behaviour. +Under the default behaviour, when a tab with a large bitmap is added, the tab control''s +height will automatically increase to accommodate the larger bitmap. + + *split*(%(arg-type)size_t% page, %(arg-type)Integer% direction) + +Split performs a split operation programmatically. The argument page indicates +the page that will be split off. This page will also become the active page after the +split. The direction argument specifies where the pane should go, it should be one +of the following: TOP, BOTTOM, LEFT, or RIGHT. + + + + + </ins></span></pre></div> <a id="trunkwxruby2doctextileauipaneinfotxtl"></a> <div class="addfile"><h4>Added: trunk/wxruby2/doc/textile/auipaneinfo.txtl (0 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/auipaneinfo.txtl         (rev 0) +++ trunk/wxruby2/doc/textile/auipaneinfo.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -0,0 +1,539 @@ </span><ins>+h1(#wxauipaneinfo). Wx::AuiPaneInfo + +AuiPaneInfo is part of the AUI class framework. +See also "AUI overview":auioverview.html. + +AuiPaneInfo specifies all the parameters for a pane. +These parameters specify where the pane is on the +screen, whether it is docked or floating, or hidden. +In addition, these parameters specify the pane''s +docked position, floating position, preferred size, +minimum size, caption text among many other parameters. + +h2. Derived from + +No base class + +h2. See also + +"AuiManager":auimanager.html, +"AuiDockArt":auidockart.html + +h2. Data structures + + + enum AuiPaneInsertLevel + { + AUI_INSERT_PANE = 0, + AUI_INSERT_ROW = 1, + AUI_INSERT_DOCK = 2 + } + + +<div id="methods"> + +h2. Methods + +* "AuiPaneInfo.new":#AuiPaneInfo_new +* "AuiPaneInfo#best_size":#AuiPaneInfo_bestsize +* "AuiPaneInfo#bottom":#AuiPaneInfo_bottom +* "AuiPaneInfo#bottom_dockable":#AuiPaneInfo_bottomdockable +* "AuiPaneInfo#caption":#AuiPaneInfo_caption +* "AuiPaneInfo#caption_visible":#AuiPaneInfo_captionvisible +* "AuiPaneInfo#centre":#AuiPaneInfo_centre +* "AuiPaneInfo#centre_pane":#AuiPaneInfo_centrepane +* "AuiPaneInfo#close_button":#AuiPaneInfo_closebutton +* "AuiPaneInfo#default_pane":#AuiPaneInfo_defaultpane +* "AuiPaneInfo#destroy_on_close":#AuiPaneInfo_destroyonclose +* "AuiPaneInfo#direction":#AuiPaneInfo_direction +* "AuiPaneInfo#dock":#AuiPaneInfo_dock +* "AuiPaneInfo#dockable":#AuiPaneInfo_dockable +* "AuiPaneInfo#fixed":#AuiPaneInfo_fixed +* "AuiPaneInfo#float":#AuiPaneInfo_float +* "AuiPaneInfo#floatable":#AuiPaneInfo_floatable +* "AuiPaneInfo#floating_position":#AuiPaneInfo_floatingposition +* "AuiPaneInfo#floating_size":#AuiPaneInfo_floatingsize +* "AuiPaneInfo#gripper":#AuiPaneInfo_gripper +* "AuiPaneInfo#gripper_top":#AuiPaneInfo_grippertop +* "AuiPaneInfo#has_border":#AuiPaneInfo_hasborder +* "AuiPaneInfo#has_caption":#AuiPaneInfo_hascaption +* "AuiPaneInfo#has_close_button":#AuiPaneInfo_hasclosebutton +* "AuiPaneInfo#has_flag":#AuiPaneInfo_hasflag +* "AuiPaneInfo#has_gripper":#AuiPaneInfo_hasgripper +* "AuiPaneInfo#has_gripper_top":#AuiPaneInfo_hasgrippertop +* "AuiPaneInfo#has_maximize_button":#AuiPaneInfo_hasmaximizebutton +* "AuiPaneInfo#has_minimize_button":#AuiPaneInfo_hasminimizebutton +* "AuiPaneInfo#has_pin_button":#AuiPaneInfo_haspinbutton +* "AuiPaneInfo#hide":#AuiPaneInfo_hide +* "AuiPaneInfo#is_bottom_dockable":#AuiPaneInfo_isbottomdockable +* "AuiPaneInfo#is_docked":#AuiPaneInfo_isdocked +* "AuiPaneInfo#is_fixed":#AuiPaneInfo_isfixed +* "AuiPaneInfo#is_floatable":#AuiPaneInfo_isfloatable +* "AuiPaneInfo#is_floating":#AuiPaneInfo_isfloating +* "AuiPaneInfo#is_left_dockable":#AuiPaneInfo_isleftdockable +* "AuiPaneInfo#is_movable":#AuiPaneInfo_ismovable +* "AuiPaneInfo#is_ok":#AuiPaneInfo_isok +* "AuiPaneInfo#is_resizable":#AuiPaneInfo_isresizable +* "AuiPaneInfo#is_right_dockable":#AuiPaneInfo_isrightdockable +* "AuiPaneInfo#is_shown":#AuiPaneInfo_isshown +* "AuiPaneInfo#is_toolbar":#AuiPaneInfo_istoolbar +* "AuiPaneInfo#is_top_dockable":#AuiPaneInfo_istopdockable +* "AuiPaneInfo#layer":#AuiPaneInfo_layer +* "AuiPaneInfo#left":#AuiPaneInfo_left +* "AuiPaneInfo#left_dockable":#AuiPaneInfo_leftdockable +* "AuiPaneInfo#max_size":#AuiPaneInfo_maxsize +* "AuiPaneInfo#maximize_button":#AuiPaneInfo_maximizebutton +* "AuiPaneInfo#min_size":#AuiPaneInfo_minsize +* "AuiPaneInfo#minimize_button":#AuiPaneInfo_minimizebutton +* "AuiPaneInfo#movable":#AuiPaneInfo_movable +* "AuiPaneInfo#name":#AuiPaneInfo_name +* "AuiPaneInfo#pane_border":#AuiPaneInfo_paneborder +* "AuiPaneInfo#pin_button":#AuiPaneInfo_pinbutton +* "AuiPaneInfo#position":#AuiPaneInfo_position +* "AuiPaneInfo#resizable":#AuiPaneInfo_resizable +* "AuiPaneInfo#right":#AuiPaneInfo_right +* "AuiPaneInfo#right_dockable":#AuiPaneInfo_rightdockable +* "AuiPaneInfo#row":#AuiPaneInfo_row +* "AuiPaneInfo#safe_set":#AuiPaneInfo_safeset +* "AuiPaneInfo#set_flag":#AuiPaneInfo_setflag +* "AuiPaneInfo#show":#AuiPaneInfo_show +* "AuiPaneInfo#toolbar_pane":#AuiPaneInfo_toolbarpane +* "AuiPaneInfo#top":#AuiPaneInfo_top +* "AuiPaneInfo#top_dockable":#AuiPaneInfo_topdockable +* "AuiPaneInfo#window":#AuiPaneInfo_window + +</div> + + + +h3(#AuiPaneInfo_wxauipaneinfo). AuiPaneInfo.new + + *AuiPaneInfo.new*(%(arg-type)AuiPaneInfo% c) + +Copy constructor. + + *destructor*() + + +h3(#AuiPaneInfo_bestsize). AuiPaneInfo#best_size + + "AuiPaneInfo":auipaneinfo.html *best_size*(%(arg-type)Size% size) + + "AuiPaneInfo":auipaneinfo.html *best_size*(%(arg-type)Integer% x, %(arg-type)Integer% y) + +BestSize() sets the ideal size for the pane. The docking manager will attempt to use this size as much as possible when docking or floating the pane. + +h3(#AuiPaneInfo_bottom). AuiPaneInfo#bottom + + "AuiPaneInfo":auipaneinfo.html *bottom*() + +Bottom() sets the pane dock position to the bottom side of the frame. This is +the same thing as calling Direction(AUI_DOCK_BOTTOM). + +h3(#AuiPaneInfo_bottomdockable). AuiPaneInfo#bottom_dockable + + "AuiPaneInfo":auipaneinfo.html *bottom_dockable*(%(arg-type)Boolean% b = true) + +BottomDockable() indicates whether a pane can be docked at the bottom of the frame. + +h3(#AuiPaneInfo_caption). AuiPaneInfo#caption + + "AuiPaneInfo":auipaneinfo.html *caption*(%(arg-type)String% c) + +Caption() sets the caption of the pane. + +h3(#AuiPaneInfo_captionvisible). AuiPaneInfo#caption_visible + + "AuiPaneInfo":auipaneinfo.html *caption_visible*(%(arg-type)Boolean% visible = true) + +CaptionVisible indicates that a pane caption should be visible. If false, no pane caption is drawn. + +h3(#AuiPaneInfo_centre). AuiPaneInfo#centre + + "AuiPaneInfo":auipaneinfo.html *centre*() + + "AuiPaneInfo":auipaneinfo.html *center*() + +Center() sets the pane dock position to the left side of the frame. +The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. + +This is the same thing as calling Direction(AUI_DOCK_CENTRE). + +h3(#AuiPaneInfo_centrepane). AuiPaneInfo#centre_pane + + "AuiPaneInfo":auipaneinfo.html *centre_pane*() + + "AuiPaneInfo":auipaneinfo.html *center_pane*() + +CentrePane() specifies that the pane should adopt the default center pane settings. Centre panes usually do not have caption bars. This function provides an easy way of preparing a pane to be displayed in the center dock position. + +h3(#AuiPaneInfo_closebutton). AuiPaneInfo#close_button + + "AuiPaneInfo":auipaneinfo.html *close_button*(%(arg-type)Boolean% visible = true) + +CloseButton() indicates that a close button should be drawn for the pane. + +h3(#AuiPaneInfo_defaultpane). AuiPaneInfo#default_pane + + "AuiPaneInfo":auipaneinfo.html *default_pane*() + +DefaultPane() specifies that the pane should adopt the default pane settings. + +h3(#AuiPaneInfo_destroyonclose). AuiPaneInfo#destroy_on_close + + "AuiPaneInfo":auipaneinfo.html *destroy_on_close*(%(arg-type)Boolean% b = true) + +DestroyOnClose() indicates whether a pane should be detroyed when it is closed. Normally a pane is simply hidden when the close button is clicked. Setting DestroyOnClose to true will cause the window to be destroyed when the user clicks the pane''s close button. + +h3(#AuiPaneInfo_direction). AuiPaneInfo#direction + + "AuiPaneInfo":auipaneinfo.html *direction*(%(arg-type)Integer% direction) + +Direction() determines the direction of the docked pane. It is functionally the same as calling Left(), Right(), Top() or Bottom(), except that docking direction may be specified programmatically via the parameter. + +h3(#AuiPaneInfo_dock). AuiPaneInfo#dock + + "AuiPaneInfo":auipaneinfo.html *dock*() + + +h3(#AuiPaneInfo_dockable). AuiPaneInfo#dockable + + "AuiPaneInfo":auipaneinfo.html *dockable*(%(arg-type)Boolean% b = true) + +Dockable() specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b). + +h3(#AuiPaneInfo_fixed). AuiPaneInfo#fixed + + "AuiPaneInfo":auipaneinfo.html *fixed*() + +Fixed() forces a pane to be fixed size so that it cannot be resized. After calling Fixed(), IsFixed() will return true. + +h3(#AuiPaneInfo_float). AuiPaneInfo#float + + "AuiPaneInfo":auipaneinfo.html *float*() + +Float() indicates that a pane should be floated. + +h3(#AuiPaneInfo_floatable). AuiPaneInfo#floatable + + "AuiPaneInfo":auipaneinfo.html *floatable*(%(arg-type)Boolean% b = true) + +Floatable() sets whether the user will be able to undock a pane and turn it into a floating window. + +h3(#AuiPaneInfo_floatingposition). AuiPaneInfo#floating_position + + "AuiPaneInfo":auipaneinfo.html *floating_position*(%(arg-type)Point% pos) + + "AuiPaneInfo":auipaneinfo.html *floating_position*(%(arg-type)Integer% x, %(arg-type)Integer% y) + +FloatingPosition() sets the position of the floating pane. + +h3(#AuiPaneInfo_floatingsize). AuiPaneInfo#floating_size + + "AuiPaneInfo":auipaneinfo.html *floating_size*(%(arg-type)Size% size) + + "AuiPaneInfo":auipaneinfo.html *floating_size*(%(arg-type)Integer% x, %(arg-type)Integer% y) + +FloatingSize() sets the size of the floating pane. + +h3(#AuiPaneInfo_gripper). AuiPaneInfo#gripper + + "AuiPaneInfo":auipaneinfo.html *gripper*(%(arg-type)Boolean% visible = true) + +Gripper() indicates that a gripper should be drawn for the pane. + +h3(#AuiPaneInfo_grippertop). AuiPaneInfo#gripper_top + + "AuiPaneInfo":auipaneinfo.html *gripper_top*(%(arg-type)Boolean% attop = true) + +GripperTop() indicates that a gripper should be drawn at the top of the pane. + +h3(#AuiPaneInfo_hasborder). AuiPaneInfo#has_border + + Boolean *has_border*() + +HasBorder() returns true if the pane displays a border. + +h3(#AuiPaneInfo_hascaption). AuiPaneInfo#has_caption + + Boolean *has_caption*() + +HasCaption() returns true if the pane displays a caption. + +h3(#AuiPaneInfo_hasclosebutton). AuiPaneInfo#has_close_button + + Boolean *has_close_button*() + +HasCloseButton() returns true if the pane displays a button to close the pane. + +h3(#AuiPaneInfo_hasflag). AuiPaneInfo#has_flag + + Boolean *has_flag*(%(arg-type)unsigned int% flag) + +HasFlag() returns true if the the property specified by flag is active for the pane. + +h3(#AuiPaneInfo_hasgripper). AuiPaneInfo#has_gripper + + Boolean *has_gripper*() + +HasGripper() returns true if the pane displays a gripper. + +h3(#AuiPaneInfo_hasgrippertop). AuiPaneInfo#has_gripper_top + + Boolean *has_gripper_top*() + +HasGripper() returns true if the pane displays a gripper at the top. + +h3(#AuiPaneInfo_hasmaximizebutton). AuiPaneInfo#has_maximize_button + + Boolean *has_maximize_button*() + +HasMaximizeButton() returns true if the pane displays a button to maximize the pane. + +h3(#AuiPaneInfo_hasminimizebutton). AuiPaneInfo#has_minimize_button + + Boolean *has_minimize_button*() + +HasMinimizeButton() returns true if the pane displays a button to minimize the pane. + +h3(#AuiPaneInfo_haspinbutton). AuiPaneInfo#has_pin_button + + Boolean *has_pin_button*() + +HasPinButton() returns true if the pane displays a button to float the pane. + +h3(#AuiPaneInfo_hide). AuiPaneInfo#hide + + "AuiPaneInfo":auipaneinfo.html *hide*() + +Hide() indicates that a pane should be hidden. + +h3(#AuiPaneInfo_isbottomdockable). AuiPaneInfo#is_bottom_dockable + + Boolean *is_bottom_dockable*() + +IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame. + +h3(#AuiPaneInfo_isdocked). AuiPaneInfo#is_docked + + Boolean *is_docked*() + +IsDocked() returns true if the pane is docked. + +h3(#AuiPaneInfo_isfixed). AuiPaneInfo#is_fixed + + Boolean *is_fixed*() + +IsFixed() returns true if the pane cannot be resized. + +h3(#AuiPaneInfo_isfloatable). AuiPaneInfo#is_floatable + + Boolean *is_floatable*() + +IsFloatable() returns true if the pane can be undocked and displayed as a floating window. + +h3(#AuiPaneInfo_isfloating). AuiPaneInfo#is_floating + + Boolean *is_floating*() + +IsFloating() returns true if the pane is floating. + +h3(#AuiPaneInfo_isleftdockable). AuiPaneInfo#is_left_dockable + + Boolean *is_left_dockable*() + +IsLeftDockable() returns true if the pane can be docked on the left of the managed frame. + +h3(#AuiPaneInfo_ismovable). AuiPaneInfo#is_movable + + Boolean *is_movable*() + +IsMoveable() returns true if the docked frame can be undocked or moved to another dock position. + +h3(#AuiPaneInfo_isok). AuiPaneInfo#is_ok + + Boolean *is_ok*() + +IsOk() returns true if the AuiPaneInfo structure is valid. A pane structure is valid if it has an associated window. + +h3(#AuiPaneInfo_isresizable). AuiPaneInfo#is_resizable + + Boolean *is_resizable*() + +IsResizable() returns true if the pane can be resized. + +h3(#AuiPaneInfo_isrightdockable). AuiPaneInfo#is_right_dockable + + Boolean *is_right_dockable*() + +IsRightDockable() returns true if the pane can be docked on the right of the managed frame. + +h3(#AuiPaneInfo_isshown). AuiPaneInfo#is_shown + + Boolean *is_shown*() + +IsShown() returns true if the pane is currently shown. + +h3(#AuiPaneInfo_istoolbar). AuiPaneInfo#is_toolbar + + Boolean *is_toolbar*() + +IsToolbar() returns true if the pane contains a toolbar. + +h3(#AuiPaneInfo_istopdockable). AuiPaneInfo#is_top_dockable + + Boolean *is_top_dockable*() + +IsTopDockable() returns true if the pane can be docked at the top of the managed frame. + +h3(#AuiPaneInfo_layer). AuiPaneInfo#layer + + "AuiPaneInfo":auipaneinfo.html *layer*(%(arg-type)Integer% layer) + +Layer() determines the layer of the docked pane. The dock layer is similar to an onion, the inner-most layer being layer 0. Each shell moving in the outward direction has a higher layer number. This allows for more complex docking layout formation. + +h3(#AuiPaneInfo_left). AuiPaneInfo#left + + "AuiPaneInfo":auipaneinfo.html *left*() + +Left() sets the pane dock position to the left side of the frame. This is the +same thing as calling Direction(AUI_DOCK_LEFT). + +h3(#AuiPaneInfo_leftdockable). AuiPaneInfo#left_dockable + + "AuiPaneInfo":auipaneinfo.html *left_dockable*(%(arg-type)Boolean% b = true) + +LeftDockable() indicates whether a pane can be docked on the left of the frame. + +h3(#AuiPaneInfo_maxsize). AuiPaneInfo#max_size + + "AuiPaneInfo":auipaneinfo.html *max_size*(%(arg-type)Size% size) + + "AuiPaneInfo":auipaneinfo.html *max_size*(%(arg-type)Integer% x, %(arg-type)Integer% y) + +MaxSize() sets the maximum size of the pane. + +h3(#AuiPaneInfo_maximizebutton). AuiPaneInfo#maximize_button + + "AuiPaneInfo":auipaneinfo.html *maximize_button*(%(arg-type)Boolean% visible = true) + +MaximizeButton() indicates that a maximize button should be drawn for the pane. + +h3(#AuiPaneInfo_minsize). AuiPaneInfo#min_size + + "AuiPaneInfo":auipaneinfo.html *min_size*(%(arg-type)Size% size) + + "AuiPaneInfo":auipaneinfo.html *min_size*(%(arg-type)Integer% x, %(arg-type)Integer% y) + +MinSize() sets the minimum size of the pane. Please note that this is only partially supported as of this writing. + +h3(#AuiPaneInfo_minimizebutton). AuiPaneInfo#minimize_button + + "AuiPaneInfo":auipaneinfo.html *minimize_button*(%(arg-type)Boolean% visible = true) + +MinimizeButton() indicates that a minimize button should be drawn for the pane. + +h3(#AuiPaneInfo_movable). AuiPaneInfo#movable + + "AuiPaneInfo":auipaneinfo.html *movable*(%(arg-type)Boolean% b = true) + +Movable indicates whether a frame can be moved. + +h3(#AuiPaneInfo_name). AuiPaneInfo#name + + "AuiPaneInfo":auipaneinfo.html *name*(%(arg-type)String% n) + +Name() sets the name of the pane so it can be referenced in lookup functions. If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager. + +h3(#AuiPaneInfo_paneborder). AuiPaneInfo#pane_border + + "AuiPaneInfo":auipaneinfo.html *pane_border*(%(arg-type)Boolean% visible = true) + +PaneBorder indicates that a border should be drawn for the pane. + +h3(#AuiPaneInfo_pinbutton). AuiPaneInfo#pin_button + + "AuiPaneInfo":auipaneinfo.html *pin_button*(%(arg-type)Boolean% visible = true) + +PinButton() indicates that a pin button should be drawn for the pane. + +h3(#AuiPaneInfo_position). AuiPaneInfo#position + + "AuiPaneInfo":auipaneinfo.html *position*(%(arg-type)Integer% pos) + +Position() determines the position of the docked pane. + +h3(#AuiPaneInfo_resizable). AuiPaneInfo#resizable + + "AuiPaneInfo":auipaneinfo.html *resizable*(%(arg-type)Boolean% resizable = true) + +Resizable() allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false. This is simply an antonym for Fixed(). + +h3(#AuiPaneInfo_right). AuiPaneInfo#right + + "AuiPaneInfo":auipaneinfo.html *right*() + +Right() sets the pane dock position to the right side of the frame. + +h3(#AuiPaneInfo_rightdockable). AuiPaneInfo#right_dockable + + "AuiPaneInfo":auipaneinfo.html *right_dockable*(%(arg-type)Boolean% b = true) + +RightDockable() indicates whether a pane can be docked on the right of the frame. + +h3(#AuiPaneInfo_row). AuiPaneInfo#row + + "AuiPaneInfo":auipaneinfo.html *row*(%(arg-type)Integer% row) + +Row() determines the row of the docked pane. + +h3(#AuiPaneInfo_safeset). AuiPaneInfo#safe_set + + *safe_set*(%(arg-type)AuiPaneInfo% source) + +Write the safe parts of a newly loaded PaneInfo structure "source" into "this" +used on loading perspectives etc. + +h3(#AuiPaneInfo_setflag). AuiPaneInfo#set_flag + + "AuiPaneInfo":auipaneinfo.html *set_flag*(%(arg-type)unsigned int% flag, + %(arg-type)Boolean% option_state) + +SetFlag() turns the property given by flag on or off with the option_state parameter. + +h3(#AuiPaneInfo_show). AuiPaneInfo#show + + "AuiPaneInfo":auipaneinfo.html *show*(%(arg-type)Boolean% show = true) + +Show() indicates that a pane should be shown. + +h3(#AuiPaneInfo_toolbarpane). AuiPaneInfo#toolbar_pane + + "AuiPaneInfo":auipaneinfo.html *toolbar_pane*() + +ToolbarPane() specifies that the pane should adopt the default toolbar pane settings. + +h3(#AuiPaneInfo_top). AuiPaneInfo#top + + "AuiPaneInfo":auipaneinfo.html *top*() + +Top() sets the pane dock position to the top of the frame. + +h3(#AuiPaneInfo_topdockable). AuiPaneInfo#top_dockable + + "AuiPaneInfo":auipaneinfo.html *top_dockable*(%(arg-type)Boolean% b = true) + +TopDockable() indicates whether a pane can be docked at the top of the frame. + +h3(#AuiPaneInfo_window). AuiPaneInfo#window + + "AuiPaneInfo":auipaneinfo.html *window*(%(arg-type)Window% w) + +Window() assigns the window pointer that the AuiPaneInfo should use. This normally does not need to be specified, as the window pointer is automatically assigned to the AuiPaneInfo structure as soon as it is added to the manager. + +h3(#AuiPaneInfo_operatorassign). AuiPaneInfo::operator+ + "AuiPaneInfo& operator":auipaneinfo& operator.html *operator=*(%(arg-type)AuiPaneInfo% c) + +Makes a copy of the AuiPaneInfo object. + </ins></span></pre></div> <a id="trunkwxruby2doctextileauitabarttxtl"></a> <div class="addfile"><h4>Added: trunk/wxruby2/doc/textile/auitabart.txtl (0 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/auitabart.txtl         (rev 0) +++ trunk/wxruby2/doc/textile/auitabart.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -0,0 +1,130 @@ </span><ins>+h1(#wxauitabart). Wx::AuiTabArt + +Tab art class. + +h2. Derived from + +No base class + +h2. Data structures + +<div id="methods"> + +h2. Methods + +* "AuiTabArt.new":#AuiTabArt_new +* "AuiTabArt#clone":#AuiTabArt_clone +* "AuiTabArt#draw_background":#AuiTabArt_drawbackground +* "AuiTabArt#draw_button":#AuiTabArt_drawbutton +* "AuiTabArt#draw_tab":#AuiTabArt_drawtab +* "AuiTabArt#get_best_tab_ctrl_size":#AuiTabArt_getbesttabctrlsize +* "AuiTabArt#get_indent_size":#AuiTabArt_getindentsize +* "AuiTabArt#get_tab_size":#AuiTabArt_gettabsize +* "AuiTabArt#set_flags":#AuiTabArt_setflags +* "AuiTabArt#set_measuring_font":#AuiTabArt_setmeasuringfont +* "AuiTabArt#set_normal_font":#AuiTabArt_setnormalfont +* "AuiTabArt#set_selected_font":#AuiTabArt_setselectedfont +* "AuiTabArt#set_sizing_info":#AuiTabArt_setsizinginfo +* "AuiTabArt#show_window_list":#AuiTabArt_showwindowlist + +</div> + + +h3(#AuiTabArt_wxauitabart). AuiTabArt.new + +h3(#AuiTabArt_clone). AuiTabArt#clone + + "AuiTabArt":auitabart.html *clone*() + +Clones the art object. + +h3(#AuiTabArt_drawbackground). AuiTabArt#draw_background + + *draw_background*(%(arg-type)DC% dc, %(arg-type)Window% wnd, %(arg-type)Rect% rect) + +Draws a background on the given area. + +h3(#AuiTabArt_drawbutton). AuiTabArt#draw_button + + *draw_button*(%(arg-type)DC% dc, %(arg-type)Window% wnd, %(arg-type)Rect% in_rect, + %(arg-type)Integer% bitmap_id, + %(arg-type)Integer% button_state, + %(arg-type)Integer% orientation, + %(arg-type)Bitmap% bitmap_override, + %(arg-type)Rect% out_rect) + +Draws a button. + +h3(#AuiTabArt_drawtab). AuiTabArt#draw_tab + + *draw_tab*(%(arg-type)DC% dc, %(arg-type)Window% wnd, %(arg-type)Rect% in_rect, + %(arg-type)String% caption, + %(arg-type)Bitmap% bitmap, + %(arg-type)Boolean% active, + %(arg-type)Integer% close_button_state, + %(arg-type)Rect% out_tab_rect, + %(arg-type)Rect% out_button_rect, + %(arg-type)Integer% x_extent) + +Draws a tab. + +h3(#AuiTabArt_getbesttabctrlsize). AuiTabArt#get_best_tab_ctrl_size + + Integer *get_best_tab_ctrl_size*(%(arg-type)Window% wnd, %(arg-type)AuiNotebookPageArray% pages) + +Returns the tab control size. + +h3(#AuiTabArt_getindentsize). AuiTabArt#get_indent_size + + Integer *get_indent_size*() + +Returns the indent size. + +h3(#AuiTabArt_gettabsize). AuiTabArt#get_tab_size + + "Size":size.html *get_tab_size*(%(arg-type)DC% dc, %(arg-type)Window% wnd, + %(arg-type)String% caption, + %(arg-type)Bitmap% bitmap, + %(arg-type)Boolean% active, + %(arg-type)Integer% close_button_state, + %(arg-type)Integer% x_extent) + +Returns the tab size for the given caption, bitmap and state. + +h3(#AuiTabArt_setflags). AuiTabArt#set_flags + + *set_flags*(%(arg-type)unsigned int% flags) + +Sets flags. + +h3(#AuiTabArt_setmeasuringfont). AuiTabArt#set_measuring_font + + *set_measuring_font*(%(arg-type)Font% font) + +Sets the font used for calculating measurements. + +h3(#AuiTabArt_setnormalfont). AuiTabArt#set_normal_font + + *set_normal_font*(%(arg-type)Font% font) + +Sets the normal font for drawing labels. + +h3(#AuiTabArt_setselectedfont). AuiTabArt#set_selected_font + + *set_selected_font*(%(arg-type)Font% font) + +Sets the font for drawing text for selected UI elements. + +h3(#AuiTabArt_setsizinginfo). AuiTabArt#set_sizing_info + + *set_sizing_info*(%(arg-type)Size% tab_ctrl_size, %(arg-type)size_t% tab_count) + +Sets sizing information. + +h3(#AuiTabArt_showwindowlist). AuiTabArt#show_window_list + + Integer *show_window_list*(%(arg-type)Window% wnd, %(arg-type)ArrayString% items, + %(arg-type)Integer% active_idx) + +Pops up a menu to show the list of windows managed by Aui. + </ins></span></pre></div> <a id="trunkwxruby2doctextileindextxtl"></a> <div class="modfile"><h4>Modified: trunk/wxruby2/doc/textile/index.txtl (1011 => 1012)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/doc/textile/index.txtl        2007-05-04 23:44:30 UTC (rev 1011) +++ trunk/wxruby2/doc/textile/index.txtl        2007-05-05 09:16:01 UTC (rev 1012) </span><span class="lines">@@ -20,14 +20,15 @@ </span><span class="cx"> </span><span class="cx"> * "Window":#window </span><span class="cx"> * "Frames":#frames </span><ins>+* "Controls":#controls </ins><span class="cx"> * "Miscellaneous windows":#misc_windows </span><span class="cx"> * "Common dialogs":#common_dialogs </span><del>-* "Controls":#controls </del><span class="cx"> * "Menus":#menus </span><span class="cx"> * "Events":#events </span><span class="cx"> * "Window layout":#window_layout </span><span class="cx"> * "Device context":#device_contexts </span><span class="cx"> * "Graphics device interface":#graphics_device_interface </span><ins>+* "Aui: advanced user interface":#aui </ins><span class="cx"> * "Validators":#validators </span><span class="cx"> * "Data Structures":#data_structures </span><span class="cx"> * "Document/view framework":#docview_framework </span><span class="lines">@@ -67,9 +68,48 @@ </span><span class="cx"> </span><span class="cx"> "top":#top </span><span class="cx"> </span><ins>+h2(#controls). Controls + +These are small windows or widgets which provide allow for various types +of user input and interaction. + +|Control|The base class for controls| +|Button|Push button control, displaying text| +|BitmapButton|Push button control, displaying a bitmap| +|ToggleButton|A button which stays pressed when clicked by user.| +|CalendarCtrl|Control showing an entire calendar month| +|CheckBox|Checkbox control| +|CheckListBox|A listbox with a checkbox to the left of each item| +|Choice|Choice control (a combobox without the editable area)| +|ComboBox|A choice with an editable area| +|DatePickerCtrl|Small date picker control| +|Gauge|A control to represent a varying quantity, such as time remaining| +|GenericDirCtrl|A control for displaying a directory tree| +|HtmlListBox|A listbox showing HTML content| +|StaticBox|A static, or group box for visually grouping related controls| +|ListBox|A list of strings for single or multiple selection| +|ListCtrl|A control for displaying lists of strings and/or icons, plus a multicolumn report view| +|ListView|A simpler interface (fa¹Âde for wxListCtrl in report mode| +|TextCtrl|Single or multiline text editing control| +|TreeCtrl|Tree (hierarchy) control| +|ScrollBar|Scrollbar control| +|SpinButton|A spin or ''up-down'' control| +|SpinCtrl|A spin control - i.e. spin button and text control| +|StaticText|One or more lines of non-editable text| +|StaticBitmap|A control to display a bitmap| +|RadioBox|A group of radio buttons| +|RadioButton|A round button to be used with others in a mutually exclusive way| +|Slider|A slider that can be dragged by the user| +|VListBox|A listbox supporting variable height rows| + +"top":#top + </ins><span class="cx"> h2(#misc_windows). Miscellaneous windows </span><span class="cx"> </span><del>-The following are a variety of classes that are derived from wxWindow. </del><ins>+The following are a variety of classes derived from Wx::Window and drawn +on the screen, but which are not simple controls like Buttons. They +typically provide ways of organising other widgets (for example, in a +Notebook), or other interaction devices (such as a StatusBar). </ins><span class="cx"> </span><span class="cx"> |Panel|A window whose colour changes according to current user settings| </span><span class="cx"> |ScrolledWindow|Window with automatically managed scrollbars| </span><span class="lines">@@ -113,41 +153,6 @@ </span><span class="cx"> </span><span class="cx"> "top":#top </span><span class="cx"> </span><del>-h2(#controls). Controls - -These are small windows which provide interaction with the user. - -|Control|The base class for controls| -|Button|Push button control, displaying text| -|BitmapButton|Push button control, displaying a bitmap| -|ToggleButton|A button which stays pressed when clicked by user.| -|CalendarCtrl|Control showing an entire calendar month| -|CheckBox|Checkbox control| -|CheckListBox|A listbox with a checkbox to the left of each item| -|Choice|Choice control (a combobox without the editable area)| -|ComboBox|A choice with an editable area| -|DatePickerCtrl|Small date picker control| -|Gauge|A control to represent a varying quantity, such as time remaining| -|GenericDirCtrl|A control for displaying a directory tree| -|HtmlListBox|A listbox showing HTML content| -|StaticBox|A static, or group box for visually grouping related controls| -|ListBox|A list of strings for single or multiple selection| -|ListCtrl|A control for displaying lists of strings and/or icons, plus a multicolumn report view| -|ListView|A simpler interface (fa¹Âde for wxListCtrl in report mode| -|TextCtrl|Single or multiline text editing control| -|TreeCtrl|Tree (hierarchy) control| -|ScrollBar|Scrollbar control| -|SpinButton|A spin or ''up-down'' control| -|SpinCtrl|A spin control - i.e. spin button and text control| -|StaticText|One or more lines of non-editable text| -|StaticBitmap|A control to display a bitmap| -|RadioBox|A group of radio buttons| -|RadioButton|A round button to be used with others in a mutually exclusive way| -|Slider|A slider that can be dragged by the user| -|VListBox|A listbox supporting variable height rows| - -"top":#top - </del><span class="cx"> h2(#menus). Menus </span><span class="cx"> </span><span class="cx"> Menus typically appear at the top of a frame. They contain drop-down </span><span class="lines">@@ -276,6 +281,18 @@ </span><span class="cx"> </span><span class="cx"> "top":#top </span><span class="cx"> </span><ins>+h2(#aui). AUI - advanced user interface + +These classes enable writing a customizable IDE-like application +with built-in docking, floatable panes and a flexible MDI-like +interface. + +|AuiManager|The central class for using and managing the interface within a window| +|AuiNotebook|A replacement notebook class with extra features| +|AuiPaneInfo|Describes a single pane| +|AuiDockArt|Art and metrics provider for customizing the docking user interface| +|AuiTabArt|Art and metrics provider for customizing the notebook user interface | + </ins><span class="cx"> h2(#validators). Validators </span><span class="cx"> </span><span class="cx"> These are the window validators, used for filtering and validating user input. </span></span></pre> </div> </div> </body> </html>
Seemingly Similar Threads
- [916] branches/wxruby2/wxwidgets_282: More Wx::AUI classes, event hooks and sample
- [900] branches/wxruby2/wxwidgets_282/swig/classes: Initial commit of AUI core classes
- [ wxruby-Bugs-10759 ] Wx::AuiManager.get_all_panes can not get all pane.
- [ wxruby-Bugs-20211 ] Unresolved symbol due to linkage error
- [ wxruby-Bugs-22782 ] AuiDefaultDockArt class missing