thr3ads.net - wxruby development - [Wxruby-development] [963] branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl: Added a few missing methods and cleaned up a bit. [Apr 2007]

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2007-Apr-14 06:17 UTC
[Wxruby-development] [963] branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl: Added a few missing methods and cleaned up a bit.

<!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>[963] branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl: Added
a few missing methods and cleaned up a bit.</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>963</dd>
<dt>Author</dt> <dd>seanlong</dd>
<dt>Date</dt> <dd>2007-04-14 02:17:38 -0400 (Sat, 14 Apr
2007)</dd>
</dl>

<h3>Log Message</h3>
<pre>Added a few missing methods and cleaned up a bit.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a
href="#brancheswxruby2wxwidgets_282doctextiledialogtxtl">branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a
id="brancheswxruby2wxwidgets_282doctextiledialogtxtl"></a>
<div class="modfile"><h4>Modified:
branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl (962 =>
963)</h4>
<pre class="diff"><span>
<span class="info">---
branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2007-04-13
19:47:28 UTC (rev 962)
+++
branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2007-04-14
06:17:38 UTC (rev 963)
</span><span class="lines">@@ -30,7 +30,7 @@
</span><span class="cx">
"set_affirmative_id":#Dialog_setaffirmativeid and
</span><span class="cx">
"set_escape_id":#Dialog_setescapeid.
</span><span class="cx"> 
</span><del>-Also notice that the
"create_button_sizer()":#Dialog_createbuttonsizer()
</del><ins>+Also notice that the
"create_button_sizer":#Dialog_createbuttonsizer
</ins><span class="cx"> should be used to create the
buttons appropriate for the current platform and
</span><span class="cx"> positioned correctly (including
their order which is
</span><span class="cx"> platform-dependent).
</span><span class="lines">@@ -132,7 +132,7 @@
</span><span class="cx"> 
</span><span class="cx"> h4. Parameters
</span><span class="cx"> 
</span><del>-* _parent_ Can be NULL, a frame or another dialog box.
</del><ins>+* _parent_ Can be nil, a frame or another dialog box.
</ins><span class="cx"> * _id_ An identifier for the
dialog. A value of -1 is taken to mean a default.
</span><span class="cx"> * _title_ The title of the
dialog.
</span><span class="cx"> * _pos_ The dialog position. A
value of (-1, -1) indicates a default position, chosen by
</span><span class="lines">@@ -219,20 +219,20 @@
</span><span class="cx">  Boolean *do_ok*()
</span><span class="cx"> 
</span><span class="cx"> This function is called when the
titlebar OK button is pressed (PocketPC only).
</span><del>-A command event for the identifier returned by
GetAffirmativeId is sent by
</del><ins>+A command event for the identifier returned by
"get_affirmative_id":dialog.html#Dialog_getaffirmativeid is sent by
</ins><span class="cx"> default. You can override this
function. If the function returns false, Widgets
</span><del>-will call Close() for the dialog.
</del><ins>+will call "close":window.html#Window_close for
the dialog.
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> h3(#Dialog_endmodal).
Dialog#end_modal
</span><span class="cx"> 
</span><del>-  *end_modal*(%(arg-type)Integer% retCode)
</del><ins>+  *end_modal*(%(arg-type)Integer% ret_code)
</ins><span class="cx"> 
</span><span class="cx"> Ends a modal dialog, passing a
value to be returned from the
"Dialog#show_modal":dialog.html#Dialog_showmodal invocation.
</span><span class="cx"> 
</span><span class="cx"> h4. Parameters
</span><span class="cx"> 
</span><del>-* _retCode_ The value that should be returned by
*ShowModal*.
</del><ins>+* _ret_code_ The value that should be returned by
*show_modal*.
</ins><span class="cx"> 
</span><span class="cx"> h4. See also
</span><span class="cx"> 
</span><span class="lines">@@ -283,14 +283,14 @@
</span><span class="cx"> 
</span><span class="cx">  "ToolBar":toolbar.html
*get_tool_bar*()
</span><span class="cx"> 
</span><del>-On PocketPC, a dialog is automatically provided with an
empty toolbar. GetToolBar
</del><ins>+On PocketPC, a dialog is automatically provided with an
empty toolbar. *get_tool_bar*
</ins><span class="cx"> allows you to access the toolbar
and add tools to it. Removing tools and adding
</span><span class="cx"> arbitrary controls are not
currently supported.
</span><span class="cx"> 
</span><span class="cx"> This function is not available on
any other platform.
</span><span class="cx"> 
</span><span class="cx"> 
</span><del>-h3(#Dialog_iconized). Dialog#iconize
</del><ins>+h3(#Dialog_iconize). Dialog#iconize
</ins><span class="cx"> 
</span><span class="cx">   *iconize*(%(arg-type)Boolean%
iconize)
</span><span class="cx"> 
</span><span class="lines">@@ -305,4 +305,145 @@
</span><span class="cx"> Note that in Windows, iconization
has no effect since dialog boxes cannot be
</span><span class="cx"> iconized. However, applications
may need to explicitly restore dialog
</span><span class="cx"> boxes under Motif which have
user-iconizable frames, and under Windows
</span><del>-calling @Iconize(false)@ will bring the window to the
front, as does
</del><ins>+calling @iconize(false)@ will bring the window to the
front, as does
+
+
+h3(#Dialog_isiconized). Dialog#is_iconized
+
+  Boolean *is_iconized*()
+
+Returns true if the dialog box is iconized. Windows only.
+
+h4. Remarks
+
+Always returns false under Windows since dialogs cannot be iconized.
+
+h3(#Dialog_ismodal). Dialog#is_modal
+
+  Boolean *is_modal*()
+
+Returns true if the dialog box is modal, false otherwise.
+
+h3(#Dialog_onsyscolourchanged). Dialog#on_sys_colour_changed
+
+  *on_sys_colour_changed*(%(arg-type)SysColourChangedEvent% event)
+
+The default handler for EVT_SYS_COLOUR_CHANGED.
+
+h4. Parameters
+
+* _event_ The colour change event.
+
+h4. Remarks
+
+Changes the dialog''s colour to conform to the current settings
(Windows only). Add an event table entry for your dialog class if you wish the
behaviour to be different (such as keeping a user-defined background colour). If
you do override this function, call
"Event::skip":event.html#Event_skip to propagate the notification to
child windows and controls.
+
+h4. See also
+
+"SysColourChangedEvent":syscolourchangedevent.html
+
+h3(#Dialog_setaffirmativeid). Dialog#set_affirmative_id
+
+  *set_affirmative_id*(%(arg-type)Integer% id)
+
+Sets the identifier to be used as OK button. When the button with this
identifier is pressed, the dialog calls
"validate":window.html#Window_validate and
"Window::transfer_data_from_window":window.html#Window_transferdatafromwindow
and, if they both return true, closes the dialog with ID_OK return code.
+
+Also, when the user presses a hardware OK button on the devices having one or
the special OK button in the PocketPC title bar, an event with this id is
generated.
+
+By default, the affirmative id is ID_OK.
+
+h4. See also
+
+"Dialog::get_affirmative_id":dialog.html#Dialog_getaffirmativeid,
"Dialog::set_escape_id":dialog.html#Dialog_setescapeid
+
+h3(#Dialog_setescapeid). Dialog#set_escape_id
+
+  *set_escape_id*(%(arg-type)Integer% id)
+
+Sets the identifier of the button which should work like the standard CANCEL
button in this dialog. When the button with this id is clicked, the dialog is
closed. Also, when the user presses ESC key in the dialog or closes the dialog
using the close button in the title bar, this is mapped to the click of the
button with the specified id.
+
+By default, the escape id is the special value ID_ANY meaning that ID_CANCEL
button is used if it''s present in the dialog and otherwise the button
with "get_affirmative_id":dialog.html#Dialog_getaffirmativeid is used.
Another special value for _id_ is ID_NONE meaning that ESC presses should be
ignored. If any other value is given, it is interpreted as the id of the button
to map the escape key to.
+
+h3(#Dialog_seticon). Dialog#set_icon
+
+  *set_icon*(%(arg-type)Icon% icon)
+
+Sets the icon for this dialog.
+
+h4. Parameters
+
+* _icon_ The icon to associate with this dialog.
+
+h4. See also 
+
+"Icon":icon.html
+
+h3(#Dialog_seticons). Dialog#set_icons
+
+  *set_icons*(%(arg-type)IconBundle% icons)
+
+Sets the icons for this dialog.
+
+h4. Parameters
+
+* _icons_ The icons to associate with this dialog.
+
+h4. See also 
+
+"IconBundle":iconbundle.html
+
+h3(#Dialog_setmodal). Dialog#set_modal
+
+  *set_modal*(%(arg-type)Boolean% flag)
+
+*NB:* This function is deprecated and doesn''t work for all ports, just
use "show_modal":dialog.html#Dialog_showmodal to show a modal dialog
instead.
+
+Allows the programmer to specify whether the dialog box is modal
("Dialog::show":dialog.html#Dialog_show blocks control until the
dialog is hidden) or modeless (control returns immediately).
+
+h4. Parameters
+
+* _flag_ If true, the dialog will be modal, otherwise it will be modeless.
+
+h3(#Dialog_setreturncode). Dialog#set_return_code
+
+  *set_return_code*(%(arg-type)Integer% ret_code)
+
+h4. Parameters
+
+* _ret_code_ The integer return code, usually a control identifier.
+
+h4. Remarks
+
+A return code is normally associated with a modal dialog, where
"Dialog::show_modal":dialog.html#Dialog_showmodal returns a code to
the application. The function
"Dialog::end_modal":dialog.html#Dialog_endmodal calls
*set_return_code*.
+
+h4. See also
+
+"Dialog::get_return_code":dialog.html#Dialog_getreturncode,
"Dialog::show_modal":dialog.html#Dialog_showmodal,
"Dialog::end_modal":dialog.html#Dialog_endmodal
+
+h3(#Dialog_show). Dialog#show
+
+  Boolean *show*(%(arg-type)Boolean% show)
+
+Hides or shows the dialog.
+
+h4. Parameters
+
+* _show_ If true, the dialog box is shown and brought to the front; otherwise
the box is hidden. If false and the dialog is modal, control is returned to the
calling program.
+
+h4. Remarks
+
+The preferred way of dismissing a modal dialog is to use
"Dialog::end_modal":dialog.html#Dialog_endmodal.
+
+h3(#Dialog_showmodal). Dialog#show_modal
+
+  Integer *show_modal*()
+
+Shows a modal dialog. Program flow does not return until the dialog has been
dismissed with "Dialog::end_modal":dialog.html#Dialog_endmodal.
+
+h4. Return value
+
+The return value is the value set with
"Dialog::set_return_code":dialog.html#Dialog_setreturncode.
+
+h4. See also
+
+"Dialog::end_modal":dialog.html#Dialog_endmodal,
"Dialog::get_return_code":dialog.html#Dialog_getreturncode,
"Dialog::set_return_code":dialog.html#Dialog_setreturncode
</ins><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>

</body>
</html>
Apparently Analagous Threads

Search for more seemingly similar threads
wxruby development - Apr 2007 - [963] branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl: Added a few missing methods and cleaned up a bit.

[Wxruby-development] [963] branches/wxruby2/wxwidgets_282/doc/textile/dialog.txtl: Added a few missing methods and cleaned up a bit.

Apparently Analagous Threads

Wisdom of the Ancients
