nobody at rubyforge.org
2007-Apr-16 20:39 UTC
[Wxruby-development] [969] branches/wxruby2/wxwidgets_282/doc/textile/window.txtl: Cleanup and fixing of broken links.
<!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>[969] branches/wxruby2/wxwidgets_282/doc/textile/window.txtl: Cleanup and fixing of broken links.</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>969</dd> <dt>Author</dt> <dd>seanlong</dd> <dt>Date</dt> <dd>2007-04-16 16:39:32 -0400 (Mon, 16 Apr 2007)</dd> </dl> <h3>Log Message</h3> <pre>Cleanup and fixing of broken links.</pre> <h3>Modified Paths</h3> <ul> <li><a href="#brancheswxruby2wxwidgets_282doctextilewindowtxtl">branches/wxruby2/wxwidgets_282/doc/textile/window.txtl</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="brancheswxruby2wxwidgets_282doctextilewindowtxtl"></a> <div class="modfile"><h4>Modified: branches/wxruby2/wxwidgets_282/doc/textile/window.txtl (968 => 969)</h4> <pre class="diff"><span> <span class="info">--- branches/wxruby2/wxwidgets_282/doc/textile/window.txtl        2007-04-16 18:17:01 UTC (rev 968) +++ branches/wxruby2/wxwidgets_282/doc/textile/window.txtl        2007-04-16 20:39:32 UTC (rev 969) </span><span class="lines">@@ -370,12 +370,12 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_clienttoscreen). Window#client_to_screen </span><span class="cx"> </span><del>- x, y = *client_to_screen*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ x, y = *client_to_screen*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> "Point":point.html = *client_to_screen*(%(arg-type)Point% pt) </span><span class="cx"> </span><span class="cx"> Converts to screen coordinates from coordinates relative to this </span><del>-window. The method may be passed _either_ two integers, representing the </del><ins>+window. The method may be passed _either_ two integers, representing the </ins><span class="cx"> _x_ and _y_ coordinates, _or_ a single "Point":point.html object. If a </span><span class="cx"> Point is passed in, one will be returned; if two integers are passed in, </span><span class="cx"> two co-ordinates will be returned. </span><span class="lines">@@ -491,7 +491,7 @@ </span><span class="cx"> </span><span class="cx"> Boolean *disable*() </span><span class="cx"> </span><del>-Disables the window, same as "Enable(":windowenable.html. </del><ins>+Disables the window, same as "enable()":window.html#Window_enable. </ins><span class="cx"> </span><span class="cx"> h4. Return value </span><span class="cx"> </span><span class="lines">@@ -604,7 +604,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_findwindowbyid). Window#find_window_by_id </span><span class="cx"> </span><del>- "Window":window.html *find_window_by_id*(%(arg-type)Integer% id, %(arg-type)Window% parent = nil) </del><ins>+ "Window":window.html *find_window_by_id*(%(arg-type)Integer% id, %(arg-type)Window% parent = nil) </ins><span class="cx"> </span><span class="cx"> Find the first window with the given _id_. </span><span class="cx"> </span><span class="lines">@@ -619,8 +619,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_findwindowbyname). Window#find_window_by_name </span><span class="cx"> </span><del>- "Window":window.html *find_window_by_name*(%(arg-type)String% name, - %(arg-type)Window% parent = nil) </del><ins>+ "Window":window.html *find_window_by_name*(%(arg-type)String% name, %(arg-type)Window% parent = nil) </ins><span class="cx"> </span><span class="cx"> Find a window by its name (as given in a window constructor or *Create* function call). </span><span class="cx"> If _parent_ is NULL, the search will start from all top-level </span><span class="lines">@@ -637,8 +636,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_findwindowbylabel). Window#find_window_by_label </span><span class="cx"> </span><del>- "Window":window.html *find_window_by_label*(%(arg-type)String% label, - %(arg-type)Window% parent = nil) </del><ins>+ "Window":window.html *find_window_by_label*(%(arg-type)String% label, %(arg-type)Window% parent = nil) </ins><span class="cx"> </span><span class="cx"> Find a window by its label. Depending on the type of window, the label may be a window title </span><span class="cx"> or panel item label. If _parent_ is NULL, the search will start from all top-level </span><span class="lines">@@ -661,7 +659,7 @@ </span><span class="cx"> margin to account for fuzziness of its calculations) to call </span><span class="cx"> </span><span class="cx"> </span><del>- window->SetClientSize(child->GetSize()); </del><ins>+ window.set_client_size(child.get_size) </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> instead of calling Fit. </span><span class="lines">@@ -671,7 +669,7 @@ </span><span class="cx"> </span><span class="cx"> *fit_inside*() </span><span class="cx"> </span><del>-Similar to "Fit":windowfit.html, but sizes the interior (virtual) size </del><ins>+Similar to "fit":window.html#Window_fit, but sizes the interior (virtual) size </ins><span class="cx"> of a window. Mainly useful with scrolled windows to reset scrollbars after </span><span class="cx"> sizing changes that do not trigger a size event, and/or scrolled windows without </span><span class="cx"> an interior sizer. This function similarly won''t do anything if there are no </span><span class="lines">@@ -683,8 +681,8 @@ </span><span class="cx"> *freeze*() </span><span class="cx"> </span><span class="cx"> Freezes the window or, in other words, prevents any updates from taking place </span><del>-on screen, the window is not redrawn at all. "Thaw":windowthaw.html must -be called to reenable window redrawing. Calls to these two functions may be </del><ins>+on screen, the window is not redrawn at all. "thaw":window.html#Window_thaw must +be called to re-enable window redrawing. Calls to these two functions may be </ins><span class="cx"> nested. </span><span class="cx"> </span><span class="cx"> This method is useful for visual appearance optimization (for example, it </span><span class="lines">@@ -816,10 +814,10 @@ </span><span class="cx"> returned font. See "Window#set_window_variant":window.html#Window_setwindowvariant </span><span class="cx"> for more about this. </span><span class="cx"> </span><del>-This static method is ``overridden'''' in many derived classes and so calling, -for example, "Button":button.html::GetClassDefaultAttributes() will typically </del><ins>+This static method is ''''overridden'''' in many derived classes and so calling, +for example, "Button#get_class_default_attributes":button.html will typically </ins><span class="cx"> return the values appropriate for a button which will be normally different </span><del>-from those returned by, say, "ListCtrl":listctrl.html::GetClassDefaultAttributes(). </del><ins>+from those returned by, say, "ListCtrl#get_class_default_attributes":listctrl.html. </ins><span class="cx"> </span><span class="cx"> The @VisualAttributes@ structure has at least the fields </span><span class="cx"> @font@, @colFg@ and @colBg@. All of them may be invalid </span><span class="lines">@@ -840,7 +838,7 @@ </span><span class="cx"> </span><span class="cx"> "Size":size.html *get_client_size*() </span><span class="cx"> </span><del>-This gets the size of the window `client area'' in pixels. </del><ins>+This gets the size of the window ''client area'' in pixels. </ins><span class="cx"> The client area is the area which may be drawn on by the programmer, </span><span class="cx"> excluding title bar, border, scrollbars, etc. </span><span class="cx"> </span><span class="lines">@@ -861,7 +859,7 @@ </span><span class="cx"> </span><span class="cx"> "LayoutConstraints":layoutconstraints.html *get_constraints*() </span><span class="cx"> </span><del>-Returns a pointer to the window''s layout constraints, or NULL if there are none. </del><ins>+Returns a pointer to the window''s layout constraints, or @nil@ if there are none. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_getcontainingsizer). Window#get_containing_sizer </span><span class="lines">@@ -869,7 +867,7 @@ </span><span class="cx"> "Sizer":sizer.html *get_containing_sizer*() </span><span class="cx"> </span><span class="cx"> Return the sizer that this window is a member of, if any, otherwise </span><del>-@NULL@. </del><ins>+@nil@. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_getcursor). Window#get_cursor </span><span class="lines">@@ -888,14 +886,14 @@ </span><span class="cx"> "VisualAttributes":visualattributes.html *get_default_attributes*() </span><span class="cx"> </span><span class="cx"> Currently this is the same as calling </span><del>-"get_class_default_attributes":#Window_getclassdefaultattributes("get_window_variant":#Window_getwindowvariant()). </del><ins>+"get_class_default_attributes":#Window_getclassdefaultattributes ("get_window_variant":#Window_getwindowvariant). </ins><span class="cx"> </span><span class="cx"> One advantage of using this function compared to the static version is that </span><span class="cx"> the call is automatically dispatched to the correct class (as usual with </span><span class="cx"> virtual functions) and you don''t have to specify the class name explicitly. </span><span class="cx"> </span><span class="cx"> The other one is that in the future this function could return different </span><del>-results, for example it might return a different font for an ``Ok'''' button </del><ins>+results, for example it might return a different font for an ''''Ok'''' button </ins><span class="cx"> than for a generic button if the users GUI is configured to show such buttons </span><span class="cx"> in bold font. Of course, the down side is that it is impossible to call this </span><span class="cx"> function without actually having an object to apply it to whereas the static </span><span class="lines">@@ -906,7 +904,7 @@ </span><span class="cx"> </span><span class="cx"> "DropTarget":droptarget.html *get_drop_target*() </span><span class="cx"> </span><del>-Returns the associated drop target, which may be NULL. </del><ins>+Returns the associated drop target, which may be @nil@. </ins><span class="cx"> </span><span class="cx"> h4. See also </span><span class="cx"> </span><span class="lines">@@ -976,7 +974,7 @@ </span><span class="cx"> </span><span class="cx"> "Window":window.html *get_grand_parent*() </span><span class="cx"> </span><del>-Returns the grandparent of a window, or NULL if there isn''t one. </del><ins>+Returns the grandparent of a window, or @nil@ if there isn''t one. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_gethandle). Window#get_handle </span><span class="lines">@@ -1070,12 +1068,12 @@ </span><span class="cx"> </span><span class="cx"> "Window":window.html *get_parent*() </span><span class="cx"> </span><del>-Returns the parent of the window, or NULL if there is no parent. </del><ins>+Returns the parent of the window, or @nil@ if there is no parent. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_getposition). Window#get_position </span><span class="cx"> </span><del>- *get_position*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ *get_position*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> "Point":point.html *get_position*() </span><span class="cx"> </span><span class="lines">@@ -1157,7 +1155,7 @@ </span><span class="cx"> "Sizer":sizer.html *get_sizer*() </span><span class="cx"> </span><span class="cx"> Return the sizer associated with the window by a previous call to </span><del>-"set_sizer()":#Window_setsizer() or @NULL@. </del><ins>+"set_sizer":#Window_setsizer or @nil@. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_gettextextent). Window#get_text_extent </span><span class="lines">@@ -1187,7 +1185,7 @@ </span><span class="cx"> </span><span class="cx"> "ToolTip":tooltip.html *get_tool_tip*() </span><span class="cx"> </span><del>-Get the associated tooltip or NULL if none. </del><ins>+Get the associated tooltip or @nil@ if none. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_getupdateregion). Window#get_update_region </span><span class="lines">@@ -1206,12 +1204,12 @@ </span><span class="cx"> </span><span class="cx"> "Validator":validator.html *get_validator*() </span><span class="cx"> </span><del>-Returns a pointer to the current validator for the window, or NULL if there is none. </del><ins>+Returns a pointer to the current validator for the window, or @nil@ if there is none. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_getvirtualsize). Window#get_virtual_size </span><span class="cx"> </span><del>- *get_virtual_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </del><ins>+ *get_virtual_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </ins><span class="cx"> </span><span class="cx"> "Size":size.html *get_virtual_size*() </span><span class="cx"> </span><span class="lines">@@ -1284,7 +1282,7 @@ </span><span class="cx"> </span><span class="cx"> Boolean *hide*() </span><span class="cx"> </span><del>-Equivalent to calling "Show":windowshow.html(@false@). </del><ins>+Equivalent to calling "show":window.html#Window_show (@false@). </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_inheritattributes). Window#inherit_attributes </span><span class="lines">@@ -1295,8 +1293,8 @@ </span><span class="cx"> window creation to intelligently set up the window visual attributes, that is </span><span class="cx"> the font and the foreground and background colours. </span><span class="cx"> </span><del>-By ``intelligently'''' the following is meant: by default, all windows use their -own "default":windowgetclassdefaultattributes.html attributes. However </del><ins>+By ''''intelligently'''' the following is meant: by default, all windows use their +own "default":window.html#Window_getclassdefaultattributes attributes. However </ins><span class="cx"> if some of the parents attributes are explicitly (that is, using </span><span class="cx"> "set_font":#Window_setfont and not </span><span class="cx"> "set_own_font":#Window_setownfont) changed and if the </span><span class="lines">@@ -1344,12 +1342,11 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_isexposed). Window#is_exposed </span><span class="cx"> </span><del>- Boolean *is_exposed*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ Boolean *is_exposed*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> Boolean *is_exposed*(%(arg-type)Point% &pt) </span><span class="cx"> </span><del>- Boolean *is_exposed*(%(arg-type)Integer% x, %(arg-type)Integer% y, %(arg-type)Integer% w, - %(arg-type)Integer% h) </del><ins>+ Boolean *is_exposed*(%(arg-type)Integer% x, %(arg-type)Integer% y, %(arg-type)Integer% w, %(arg-type)Integer% h) </ins><span class="cx"> </span><span class="cx"> Boolean *is_exposed*(%(arg-type)Rect% &rect) </span><span class="cx"> </span><span class="lines">@@ -1434,7 +1431,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_move). Window#move </span><span class="cx"> </span><del>- *move*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ *move*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> *move*(%(arg-type)Point% pt) </span><span class="cx"> </span><span class="lines">@@ -1453,7 +1450,7 @@ </span><span class="cx"> as the call: </span><span class="cx"> </span><span class="cx"> </span><del>- SetSize(x, y, -1, -1, SIZE_USE_EXISTING); </del><ins>+ set_size(x, y, -1, -1, SIZE_USE_EXISTING) </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h4. See also </span><span class="lines">@@ -1562,9 +1559,9 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_popupmenu). Window#popup_menu </span><span class="cx"> </span><del>- Boolean *popup_menu*(%(arg-type)Menu% menu, %(arg-type)Point% pos = DEFAULT_POSITION) </del><ins>+ Boolean *popup_menu*(%(arg-type)Menu% menu, %(arg-type)Point% pos = DEFAULT_POSITION) </ins><span class="cx"> </span><del>- Boolean *popup_menu*(%(arg-type)Menu% menu, %(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ Boolean *popup_menu*(%(arg-type)Menu% menu, %(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> Pops up the given menu at the specified coordinates, relative to this </span><span class="cx"> window, and returns control when the user has dismissed the menu. If a </span><span class="lines">@@ -1639,7 +1636,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_refresh). Window#refresh </span><span class="cx"> </span><del>- *refresh*(%(arg-type)Boolean% eraseBackground = @true@, %(arg-type)Rect% rect = nil) </del><ins>+ *refresh*(%(arg-type)Boolean% eraseBackground = @true@, %(arg-type)Rect% rect = nil) </ins><span class="cx"> </span><span class="cx"> Causes this window, and all of its children recursively (except under GTK1 </span><span class="cx"> where this is not implemented), to be repainted. Note that repainting doesn''t </span><span class="lines">@@ -1651,7 +1648,7 @@ </span><span class="cx"> </span><span class="cx"> * _eraseBackground_ If @true@, the background will be </span><span class="cx"> erased. </span><del>-* _rect_ If non-NULL, only the given rectangle will </del><ins>+* _rect_ If non-nil, only the given rectangle will </ins><span class="cx"> be treated as damaged. </span><span class="cx"> </span><span class="cx"> h4. See also </span><span class="lines">@@ -1661,19 +1658,19 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_refreshrect). Window#refresh_rect </span><span class="cx"> </span><del>- *refresh_rect*(%(arg-type)Rect% rect, %(arg-type)Boolean% eraseBackground = ) </del><ins>+ *refresh_rect*(%(arg-type)Rect% rect, %(arg-type)Boolean% eraseBackground = @true@) </ins><span class="cx"> </span><span class="cx"> Redraws the contents of the given rectangle: only the area inside it will be </span><span class="cx"> repainted. </span><span class="cx"> </span><del>-This is the same as "Refresh":windowrefresh.html but has a nicer syntax </del><ins>+This is the same as "refresh":window.html#Window_refresh but has a nicer syntax </ins><span class="cx"> as it can be called with a temporary Rect object as argument like this </span><del>-@RefreshRect(Rect(x, y, w, h))@. </del><ins>+@refresh_rect(Rect(x, y, w, h))@. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_registerhotkey). Window#register_hot_key </span><span class="cx"> </span><del>- Boolean *register_hot_key*(%(arg-type)Integer% hotkeyId, %(arg-type)Integer% modifiers, </del><ins>+ Boolean *register_hot_key*(%(arg-type)Integer% hotkeyId, %(arg-type)Integer% modifiers, </ins><span class="cx"> %(arg-type)Integer% virtualKeyCode) </span><span class="cx"> </span><span class="cx"> Registers a system wide hotkey. Every time the user presses the hotkey registered here, this window </span><span class="lines">@@ -1743,7 +1740,7 @@ </span><span class="cx"> </span><span class="cx"> h4. Parameters </span><span class="cx"> </span><del>-* _handler_ The event handler to remove, must be non @NULL@ and </del><ins>+* _handler_ The event handler to remove, must be non @nil@ and </ins><span class="cx"> must be present in this windows event handlers chain </span><span class="cx"> </span><span class="cx"> h4. Return value </span><span class="lines">@@ -1772,7 +1769,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_screentoclient). Window#screen_to_client </span><span class="cx"> </span><del>- x, y *screen_to_client*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ x, y *screen_to_client*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> "Point":point.html *screen_to_client*(%(arg-type)Point% pt) </span><span class="cx"> </span><span class="lines">@@ -1830,7 +1827,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_scrollwindow). Window#scroll_window </span><span class="cx"> </span><del>- *scroll_window*(%(arg-type)Integer% dx, %(arg-type)Integer% dy, %(arg-type)Rect% rect = nil) </del><ins>+ *scroll_window*(%(arg-type)Integer% dx, %(arg-type)Integer% dy, %(arg-type)Rect% rect = nil) </ins><span class="cx"> </span><span class="cx"> Physically scrolls the pixels in the window and move child windows accordingly. </span><span class="cx"> </span><span class="lines">@@ -1962,7 +1959,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setclientsize). Window#set_client_size </span><span class="cx"> </span><del>- *set_client_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </del><ins>+ *set_client_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </ins><span class="cx"> </span><span class="cx"> *set_client_size*(%(arg-type)Size% size) </span><span class="cx"> </span><span class="lines">@@ -2009,9 +2006,9 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setdimensions). Window#set_dimensions </span><span class="cx"> </span><del>- *set_size*(%(arg-type)Integer% x, %(arg-type)Integer% y, - %(arg-type)Integer% width, %(arg-type)Integer% height, - %(arg-type)Integer% sizeFlags = SIZE_AUTO) </del><ins>+ *set_size*(%(arg-type)Integer% x, %(arg-type)Integer% y, + %(arg-type)Integer% width, %(arg-type)Integer% height, + %(arg-type)Integer% sizeFlags = SIZE_AUTO) </ins><span class="cx"> </span><span class="cx"> Specifies the size and position of the window, in pixel units. </span><span class="cx"> </span><span class="lines">@@ -2159,9 +2156,9 @@ </span><span class="cx"> |@WS_EX_VALIDATE_RECURSIVELY@|TransferDataTo/FromWindow()and Validate() methods will recursively descend into all children of thewindow if it has this style flag set.| </span><span class="cx"> |@WS_EX_BLOCK_EVENTS@|Normally, the commandevents are propagated upwards to the window parent recursively until a handlerfor them is found. Using this style allows to prevent them from beingpropagated beyond this window. Notice that Dialog has this style on bydefault for the reasons explained in the"event processing overview":eventprocessing.html.| </span><span class="cx"> |@WS_EX_TRANSIENT@|This can be used to prevent awindow from being used as an implicit parent for the dialogs which werecreated without a parent. It is useful for the windows which can disappear atany moment as creating children of such windows results in fatal problems.| </span><del>-|@FRAME_EX_CONTEXTHELP@|Under Windows, puts a query button on thecaption. When pressed, Windows will go into a context-sensitive help mode and Widgets will senda EVT_HELP event if the user clicked on an application window.This style cannot be used together with MAXIMIZE_BOX or MINIMIZE_BOX, soyou should use the style of@DEFAULT_FRAME_STYLE & @@(MINIMIZE_BOX | MAXIMIZE_BOX)@ for theframes having this style (the dialogs don''t have minimize nor maximize box bydefault)| -|@WS_EX_PROCESS_IDLE@|This window should always process idle events, evenif the mode set by "IdleEvent#set_mode":idleevent.html#IdleEvent_setmode is IDLE_PROCESS_SPECIFIED.| -|@WS_EX_PROCESS_UI_UPDATES@|This window should always process UI update events,even if the mode set by "UpdateUIEvent#set_mode":updateuievent.html#UpdateUIEvent_setmode is UPDATE_UI_PROCESS_SPECIFIED.| </del><ins>+|@FRAME_EX_CONTEXTHELP@|Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and Widgets will send a EVT_HELP event if the user clicked on an application window. This style cannot be used together with @MAXIMIZE_BOX@ or @MINIMIZE_BOX@, soyou should use the style of @DEFAULT_FRAME_STYLE@ & (@MINIMIZE_BOX@ | @MAXIMIZE_BOX@) for the frames having this style (the dialogs don''t have minimize nor maximize box bydefault)| +|@WS_EX_PROCESS_IDLE@|This window should always process idle events, evenif the mode set by "IdleEvent#set_mode":idleevent.html#IdleEvent_setmode is @IDLE_PROCESS_SPECIFIED@.| +|@WS_EX_PROCESS_UI_UPDATES@|This window should always process UI update events,even if the mode set by "UpdateUIEvent#set_mode":updateuievent.html#UpdateUIEvent_setmode is @UPDATE_UI_PROCESS_SPECIFIED@.| </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> </span><span class="lines">@@ -2312,7 +2309,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setscrollbar). Window#set_scrollbar </span><span class="cx"> </span><del>- *set_scrollbar*(%(arg-type)Integer% orientation, %(arg-type)Integer% position, </del><ins>+ *set_scrollbar*(%(arg-type)Integer% orientation, %(arg-type)Integer% position, </ins><span class="cx"> %(arg-type)Integer% thumbSize, </span><span class="cx"> %(arg-type)Integer% range, </span><span class="cx"> %(arg-type)Boolean% refresh = @true@) </span><span class="lines">@@ -2334,7 +2331,7 @@ </span><span class="cx"> </span><span class="cx"> You would use: </span><span class="cx"> </span><del>- set_scroll_bar(VERTICAL, 0, 16, 50); </del><ins>+ set_scrollbar(VERTICAL, 0, 16, 50) </ins><span class="cx"> </span><span class="cx"> Note that with the window at this size, the thumb position can never go </span><span class="cx"> above 50 minus 16, or 34. </span><span class="lines">@@ -2344,8 +2341,8 @@ </span><span class="cx"> </span><span class="cx"> When defining your own scrollbar behaviour, you will always need to </span><span class="cx"> recalculate the scrollbar settings when the window size changes. You </span><del>-could therefore put your scrollbar calculations and SetScrollbar call -into a function named AdjustScrollbars, which can be called initially </del><ins>+could therefore put your scrollbar calculations and set_scrollbar call +into a function named adjust_scrollbars, which can be called initially </ins><span class="cx"> and also from your "SizeEvent":sizeevent.html handler function. </span><span class="cx"> </span><span class="cx"> h4. See also </span><span class="lines">@@ -2357,7 +2354,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setscrollpage). Window#set_scroll_page </span><span class="cx"> </span><del>- *set_scroll_page*(%(arg-type)Integer% orientation, %(arg-type)Integer% pageSize, </del><ins>+ *set_scroll_page*(%(arg-type)Integer% orientation, %(arg-type)Integer% pageSize, </ins><span class="cx"> %(arg-type)Boolean% refresh = @true@) </span><span class="cx"> </span><span class="cx"> Sets the page size of one of the built-in scrollbars. </span><span class="lines">@@ -2392,7 +2389,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setscrollpos). Window#set_scroll_pos </span><span class="cx"> </span><del>- *set_scroll_pos*(%(arg-type)Integer% orientation, %(arg-type)Integer% pos, </del><ins>+ *set_scroll_pos*(%(arg-type)Integer% orientation, %(arg-type)Integer% pos, </ins><span class="cx"> %(arg-type)Boolean% refresh = @true@) </span><span class="cx"> </span><span class="cx"> Sets the position of one of the built-in scrollbars. </span><span class="lines">@@ -2417,7 +2414,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setscrollrange). Window#set_scroll_range </span><span class="cx"> </span><del>- *set_scroll_range*(%(arg-type)Integer% orientation, %(arg-type)Integer% range, </del><ins>+ *set_scroll_range*(%(arg-type)Integer% orientation, %(arg-type)Integer% range, </ins><span class="cx"> %(arg-type)Boolean% refresh = @true@) </span><span class="cx"> </span><span class="cx"> Sets the range of one of the built-in scrollbars. </span><span class="lines">@@ -2466,7 +2463,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setsizehints). Window#set_size_hints </span><span class="cx"> </span><del>- *set_size_hints*(%(arg-type)Integer% minW, %(arg-type)Integer% minH, %(arg-type)Integer% maxW=-1, </del><ins>+ *set_size_hints*(%(arg-type)Integer% minW, %(arg-type)Integer% minH, %(arg-type)Integer% maxW=-1, </ins><span class="cx"> %(arg-type)Integer% maxH=-1, </span><span class="cx"> %(arg-type)Integer% incW=-1, </span><span class="cx"> %(arg-type)Integer% incH=-1) </span><span class="lines">@@ -2500,7 +2497,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setsizer). Window#set_sizer </span><span class="cx"> </span><del>- *set_sizer*(%(arg-type)Sizer% sizer, %(arg-type)Boolean% deleteOld=true) </del><ins>+ *set_sizer*(%(arg-type)Sizer% sizer, %(arg-type)Boolean% deleteOld=true) </ins><span class="cx"> </span><span class="cx"> Sets the window to have the given layout sizer. The window </span><span class="cx"> will then own the object, and will take care of its deletion. </span><span class="lines">@@ -2509,7 +2506,7 @@ </span><span class="cx"> </span><span class="cx"> Note that this function will also call </span><span class="cx"> "set_auto_layout":#Window_setautolayout implicitly with @true@ </span><del>-parameter if the _sizer_\/ is non-NULL and @false@ otherwise. </del><ins>+parameter if the _sizer_ is non-nil and @false@ otherwise. </ins><span class="cx"> </span><span class="cx"> h4. Parameters </span><span class="cx"> </span><span class="lines">@@ -2531,7 +2528,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setsizerandfit). Window#set_sizer_and_fit </span><span class="cx"> </span><del>- *set_sizer_and_fit*(%(arg-type)Sizer% sizer, %(arg-type)Boolean% deleteOld=true) </del><ins>+ *set_sizer_and_fit*(%(arg-type)Sizer% sizer, %(arg-type)Boolean% deleteOld=true) </ins><span class="cx"> </span><span class="cx"> The same as "set_sizer":#Window_setsizer, except it also sets the size hints </span><span class="cx"> for the window based on the sizer''s minimum size. </span><span class="lines">@@ -2573,7 +2570,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_setvirtualsize). Window#set_virtual_size </span><span class="cx"> </span><del>- *set_virtual_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </del><ins>+ *set_virtual_size*(%(arg-type)Integer% width, %(arg-type)Integer% height) </ins><span class="cx"> </span><span class="cx"> *set_virtual_size*(%(arg-type)Size% size) </span><span class="cx"> </span><span class="lines">@@ -2621,7 +2618,7 @@ </span><span class="cx"> *set_window_style_flag*(%(arg-type)Integer% style) </span><span class="cx"> </span><span class="cx"> Sets the style of the window. Please note that some styles cannot be changed </span><del>-after the window creation and that "Refresh()":windowrefresh.html might </del><ins>+after the window creation and that "refresh":window.html#Window_refresh might </ins><span class="cx"> be called after changing the others for the change to take place immediately. </span><span class="cx"> </span><span class="cx"> See "Window styles":windowstyles.html for more information about flags. </span><span class="lines">@@ -2690,8 +2687,8 @@ </span><span class="cx"> *thaw*() </span><span class="cx"> </span><span class="cx"> Reenables window updating after a previous call to </span><del>-"Freeze":windowfreeze.html. To really thaw the control, it must be called -exactly the same number of times as "Freeze":windowfreeze.html. </del><ins>+"freeze":window.html#Window_freeze. To really thaw the control, it must be called +exactly the same number of times as "freeze":window.html#Window_freeze. </ins><span class="cx"> </span><span class="cx"> </span><span class="cx"> h3(#Window_transferdatafromwindow). Window#transfer_data_from_window </span><span class="lines">@@ -2702,7 +2699,7 @@ </span><span class="cx"> @false@ if a transfer failed. </span><span class="cx"> </span><span class="cx"> If the window has @WS_EX_VALIDATE_RECURSIVELY@ extra style flag set, </span><del>-the method will also call TransferDataFromWindow() of all child windows. </del><ins>+the method will also call transfer_data_from_window() of all child windows. </ins><span class="cx"> </span><span class="cx"> h4. See also </span><span class="cx"> </span><span class="lines">@@ -2716,7 +2713,7 @@ </span><span class="cx"> Transfers values to child controls from data areas specified by their validators. </span><span class="cx"> </span><span class="cx"> If the window has @WS_EX_VALIDATE_RECURSIVELY@ extra style flag set, </span><del>-the method will also call TransferDataToWindow() of all child windows. </del><ins>+the method will also call transfer_data_to_window() of all child windows. </ins><span class="cx"> </span><span class="cx"> h4. Return value </span><span class="cx"> </span><span class="lines">@@ -2735,7 +2732,7 @@ </span><span class="cx"> </span><span class="cx"> h4. Parameters </span><span class="cx"> </span><del>-* _hotkeyId_ Numeric identifier of the hotkey. Must be the same id that was passed to RegisterHotKey. </del><ins>+* _hotkeyId_ Numeric identifier of the hotkey. Must be the same id that was passed to register_hot_key. </ins><span class="cx"> </span><span class="cx"> h4. Return value </span><span class="cx"> </span><span class="lines">@@ -2788,16 +2785,16 @@ </span><span class="cx"> }; </span><span class="cx"> </span><span class="cx"> </span><del>-If you are calling this function from an OnInternalIdle or OnIdle </del><ins>+If you are calling this function from an on_internal_idle or on_idle </ins><span class="cx"> function, make sure you pass the UPDATE_UI_FROMIDLE flag, since </span><span class="cx"> this tells the window to only update the UI elements that need </span><span class="cx"> to be updated in idle time. Some windows update their elements </span><span class="cx"> only when necessary, for example when a menu is about to be shown. </span><del>-The following is an example of how to call UpdateWindowUI from </del><ins>+The following is an example of how to call update_window_ui from </ins><span class="cx"> an idle function. </span><span class="cx"> </span><span class="cx"> </span><del>- void MyWindow::OnInternalIdle() </del><ins>+ void MyWindow::on_internal_idle() </ins><span class="cx"> { </span><span class="cx"> if (UpdateUIEvent::CanUpdate(this)) </span><span class="cx"> UpdateWindowUI(UPDATE_UI_FROMIDLE); </span><span class="lines">@@ -2831,7 +2828,7 @@ </span><span class="cx"> </span><span class="cx"> h3(#Window_warppointer). Window#warp_pointer </span><span class="cx"> </span><del>- *warp_pointer*(%(arg-type)Integer% x, %(arg-type)Integer% y) </del><ins>+ *warp_pointer*(%(arg-type)Integer% x, %(arg-type)Integer% y) </ins><span class="cx"> </span><span class="cx"> Moves the pointer to the given position on the window. </span><span class="cx"> </span></span></pre> </div> </div> </body> </html>
Reasonably Related Threads
- [997] branches/wxruby2/wxwidgets_282: Window - 2.6 -> 2.8 API, new methods and deprecations; update doc
- [785] trunk/wxruby2/doc/textile/window.txtl: Remove set_constraints, correct docs for set_dimensions and set_size
- [894] branches/wxruby2/wxwidgets_282/doc/textile/window.txtl: Document changed Window methods in 2.6 -> 2.8 API
- [926] branches/wxruby2/wxwidgets_282: Update Dialog wx2.6 -> wx2.8 API, remove deprecations and cruft, update doc
- [840] trunk/wxruby2/doc/textile/boxsizer.txtl: Add methods listing, remove one bad link and not-for-user method descriptions