nobody at rubyforge.org
2006-Nov-21 22:14 UTC
[Wxruby-development] [745] trunk/wxruby2/doc/textile/choice.txtl: Correct ruby method signature for constructor, bit more explanatory text
<!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>[745] trunk/wxruby2/doc/textile/choice.txtl: Correct ruby method
signature for constructor, bit more explanatory text</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>745</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-11-21 17:14:26 -0500 (Tue, 21 Nov
2006)</dd>
</dl>
<h3>Log Message</h3>
<pre>Correct ruby method signature for constructor, bit more explanatory
text</pre>
<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2doctextilechoicetxtl">trunk/wxruby2/doc/textile/choice.txtl</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2doctextilechoicetxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/choice.txtl (744 => 745)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/choice.txtl        2006-11-21
19:59:03 UTC (rev 744)
+++
trunk/wxruby2/doc/textile/choice.txtl        2006-11-21
22:14:26 UTC (rev 745)
</span><span class="lines">@@ -1,8 +1,10 @@
</span><span class="cx"> h1(#wxchoice). Wx::Choice
</span><span class="cx">
</span><del>-A choice item is used to select one of a list of
strings. Unlike a
-listbox, only the selection is visible until the user pulls down the
-menu of choices.
</del><ins>+A choice item (also often called a
''dropdown'') is used to select one of
+a list of strings. Unlike a listbox, only the selection is visible until
+the user pulls down the menu of choices. By using the client_data
+functions inherited from "ControlWithItems":controlwithitems.html ,
ruby
+objects can be associated with items within the dropdown.
</ins><span class="cx">
</span><span class="cx"> h2. Derived from
</span><span class="cx">
</span><span class="lines">@@ -53,19 +55,11 @@
</span><span class="cx">
</span><span class="cx"> *Choice.new*(%(arg-type)Window%
parent, %(arg-type)Integer% id, %(arg-type)Point% pos,
</span><span class="cx"> %(arg-type)Size%
size,
</span><del>- %(arg-type)Integer% n,
- %(arg-type)String% choices[],
</del><ins>+ %(arg-type)Array% choices[],
</ins><span class="cx"> %(arg-type)Integer%
style = 0,
</span><span class="cx">
%(arg-type)Validator% validator = DEFAULT_VALIDATOR,
</span><span class="cx"> %(arg-type)String%
name = "choice")
</span><span class="cx">
</span><del>- *Choice.new*(%(arg-type)Window% parent,
%(arg-type)Integer% id, %(arg-type)Point% pos,
- %(arg-type)Size% size,
- %(arg-type)ArrayString% choices,
- %(arg-type)Integer% style = 0,
- %(arg-type)Validator% validator = DEFAULT_VALIDATOR,
- %(arg-type)String% name = "choice")
-
</del><span class="cx"> Constructor, creating and showing
a choice.
</span><span class="cx">
</span><span class="cx"> h4. Parameters
</span><span class="lines">@@ -75,7 +69,6 @@
</span><span class="cx"> * _pos_ Window position.
</span><span class="cx"> * _size_ Window size. If the
default size (-1, -1) is specified then the choice is sized
</span><span class="cx"> appropriately.
</span><del>-* _n_ Number of strings with which to initialise the
choice control.
</del><span class="cx"> * _choices_ An array of strings
with which to initialise the choice control.
</span><span class="cx"> * _style_ Window style. See
"Choice":choice.html.
</span><span class="cx"> * _validator_ Window validator.
</span><span class="lines">@@ -85,33 +78,15 @@
</span><span class="cx">
</span><span class="cx">
"Choice#create":choice.html#Choice_create,
"Validator":validator.html
</span><span class="cx">
</span><del>-
-
-
-
-
- *destructor*()
-
-Destructor, destroying the choice item.
-
-
</del><span class="cx"> h3(#Choice_create). Choice#create
</span><span class="cx">
</span><span class="cx"> Boolean
*create*(%(arg-type)Window% parent, %(arg-type)Integer% id, %(arg-type)Point%
pos,
</span><span class="cx"> %(arg-type)Size%
size,
</span><del>- %(arg-type)Integer% n,
- %(arg-type)String% choices[],
</del><ins>+ %(arg-type)Array% choices[],
</ins><span class="cx">
%(arg-type)Integer% style = 0,
</span><span class="cx">
%(arg-type)Validator% validator = DEFAULT_VALIDATOR,
</span><span class="cx">
%(arg-type)String% name = "choice")
</span><span class="cx">
</span><del>- Boolean *create*(%(arg-type)Window% parent,
%(arg-type)Integer% id, %(arg-type)Point% pos,
- %(arg-type)Size% size,
- %(arg-type)ArrayString% choices,
- %(arg-type)Integer% style = 0,
- %(arg-type)Validator% validator = DEFAULT_VALIDATOR,
- %(arg-type)String% name = "choice")
-
</del><span class="cx"> Creates the choice for two-step
construction. See "Choice.new":choice.html#Choice_new.
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -134,7 +109,7 @@
</span><span class="cx">
</span><span class="cx"> h4. Remarks
</span><span class="cx">
</span><del>-This is implemented for Motif only and always returns
$1$ for the other
</del><ins>+This is implemented for Motif only and always returns
@1@ for the other
</ins><span class="cx"> platforms.
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -149,11 +124,6 @@
</span><span class="cx"> item in it. When it is not shown,
its result is the same as for the other
</span><span class="cx"> function.
</span><span class="cx">
</span><del>-2.6.2 (before this version
-"get_selection":#Choice_getselection itself behaved like
-this).
-
-
</del><span class="cx"> h3(#Choice_setcolumns).
Choice#set_columns
</span><span class="cx">
</span><span class="cx">
*set_columns*(%(arg-type)Integer% n = 1)
</span></span></pre>
</div>
</div>
</body>
</html>
Seemingly Similar Threads
- [768] trunk/wxruby2/doc/textile/checklistbox.txtl: Corrected constructor method signature
- [746] trunk/wxruby2/doc/textile/listbox.txtl: Correct ruby method signature for methods that accept an array of strings
- [966] branches/wxruby2/wxwidgets_282/doc/textile/listbox.txtl: Fix methods which don''t need a ''n'' item for arrays in Ruby
- [906] branches/wxruby2/wxwidgets_282: Wx::ComboBox API 2.6 -> 2.8, plus some doc corrections
- [965] branches/wxruby2/wxwidgets_282/doc/textile: Misc.
