nobody at rubyforge.org
2006-Dec-12 01:45 UTC
[Wxruby-development] [785] trunk/wxruby2/doc/textile/window.txtl: Remove set_constraints, correct docs for set_dimensions and set_size
<!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>[785] trunk/wxruby2/doc/textile/window.txtl: Remove
set_constraints, correct docs for set_dimensions and set_size</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>785</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-12-11 20:45:34 -0500 (Mon, 11 Dec
2006)</dd>
</dl>
<h3>Log Message</h3>
<pre>Remove set_constraints, correct docs for set_dimensions and
set_size</pre>
<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2doctextilewindowtxtl">trunk/wxruby2/doc/textile/window.txtl</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2doctextilewindowtxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/window.txtl (784 => 785)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/window.txtl        2006-12-12
00:44:18 UTC (rev 784)
+++
trunk/wxruby2/doc/textile/window.txtl        2006-12-12
01:45:34 UTC (rev 785)
</span><span class="lines">@@ -2047,28 +2047,50 @@
</span><span class="cx">
</span><span class="cx">
"::SetCursor":setcursor.html, "Cursor":cursor.html
</span><span class="cx">
</span><ins>+h3(#Window_setdimensions). Window#set_dimensions
</ins><span class="cx">
</span><del>-h3(#Window_setconstraints). Window#set_constraints
</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><del>- *set_constraints*(%(arg-type)LayoutConstraints%
constraints)
</del><ins>+Specifies the size and position of the window, in pixel
units.
</ins><span class="cx">
</span><del>-Sets the window to have the given layout constraints.
The window
-will then own the object, and will take care of its deletion.
-If an existing layout constraints object is already owned by the
-window, it will be deleted.
-
</del><span class="cx"> h4. Parameters
</span><span class="cx">
</span><del>-* _constraints_ The constraints to set. Pass NULL to
disassociate and delete the window''s
-constraints.
</del><ins>+* _x_ Required x position in pixels, or -1 to indicate
that the existing
+value should be used.
+* _y_ Required y position in pixels, or -1 to indicate that the existing
+value should be used.
+* _width_ Required width in pixels, or -1 to indicate that the existing
+value should be used.
+* _height_ Required height position in pixels, or -1 to indicate that the
existing
+value should be used.
+* _sizeFlags_ Indicates the interpretation of other parameters. It is a bit
list of the following:
</ins><span class="cx">
</span><del>-h4. Remarks
</del><ins>+*SIZE_AUTO_WIDTH*: a -1 width value is taken to indicate
+a wxRuby-supplied default width.
</ins><span class="cx">
</span><del>-You must call
"Window#set_auto_layout":window.html#Window_setautolayout to tell a
window to use
-the constraints automatically in OnSize; otherwise, you must override OnSize
and call Layout()
-explicitly. When setting both a LayoutConstraints and a
"Sizer":sizer.html, only the
-sizer will have effect.
</del><ins>+*SIZE_AUTO_HEIGHT*: a -1 height value is taken to
indicate
+a wxRuby-supplied default width.
</ins><span class="cx">
</span><ins>+*SIZE_AUTO*: -1 size values are taken to indicate
+a wxRuby-supplied default size.
+
+*SIZE_USE_EXISTING*: existing dimensions should be used
+if -1 values are supplied.
+
+*SIZE_ALLOW_MINUS_ONE*: allow dimensions of -1 and less to be interpreted
+as real dimensions, not default values.
+
+*SIZE_FORCE*: normally, if the position and the size of the window are
+already the same as the parameters of this function, nothing is done. but with
+this flag a window resize may be forced even in this case (supported in wx
+2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
+
+h4. See also
+
+"set_size":#Window_setsize
+
</ins><span class="cx"> h3(#Window_setinitialbestsize).
Window#set_initial_best_size
</span><span class="cx">
</span><span class="cx">
*set_initial_best_size*(%(arg-type)Size% size)
</span><span class="lines">@@ -2127,7 +2149,6 @@
</span><span class="cx">
</span><span class="cx">
"set_foreground_colour":#Window_setforegroundcolour,
"inherit_attributes":#Window_inheritattributes
</span><span class="cx">
</span><del>-
</del><span class="cx"> h3(#Window_setdroptarget).
Window#set_drop_target
</span><span class="cx">
</span><span class="cx">
*set_drop_target*(%(arg-type)DropTarget% target)
</span><span class="lines">@@ -2139,10 +2160,7 @@
</span><span class="cx"> h4. See also
</span><span class="cx">
</span><span class="cx">
"Window#get_drop_target":window.html#Window_getdroptarget,
</span><del>-"Drag and drop overview":dndoverview.html
</del><span class="cx">
</span><del>-
-
</del><span class="cx"> h3(#Window_seteventhandler).
Window#set_event_handler
</span><span class="cx">
</span><span class="cx">
*set_event_handler*(%(arg-type)EvtHandler% handler)
</span><span class="lines">@@ -2223,7 +2241,7 @@
</span><span class="cx"> h4. Parameters
</span><span class="cx">
</span><span class="cx"> * _font_ Font to associate with
this window, pass
</span><del>-@NullFont@ to reset to the default font.
</del><ins>+@Wx::NULL_FONT@ reset to the default font.
</ins><span class="cx">
</span><span class="cx"> h4. See also
</span><span class="cx">
</span><span class="lines">@@ -2245,7 +2263,7 @@
</span><span class="cx"> h4. Parameters
</span><span class="cx">
</span><span class="cx"> * _colour_ The colour to be used
as the foreground colour, pass
</span><del>- @NullColour@ to reset to the default colour.
</del><ins>+ @Wx::NULL_COLOUR@ to reset to the default colour.
</ins><span class="cx">
</span><span class="cx"> h4. Remarks
</span><span class="cx">
</span><span class="lines">@@ -2356,22 +2374,19 @@
</span><span class="cx">
</span><span class="cx"> You would use:
</span><span class="cx">
</span><ins>+ set_scroll_bar(VERTICAL, 0, 16, 50);
</ins><span class="cx">
</span><del>- SetScrollbar(VERTICAL, 0, 16, 50);
-
-
-
</del><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="cx">
</span><del>-You can determine how many lines are currently visible
by dividing the current view
-size by the character height in pixels.
</del><ins>+You can determine how many lines are currently visible
by dividing the
+current view size by the character height in pixels.
</ins><span class="cx">
</span><del>-When defining your own scrollbar behaviour, you will
always need to recalculate
-the scrollbar settings when the window size changes. You could therefore put
your
-scrollbar calculations and SetScrollbar
-call into a function named AdjustScrollbars, which can be called initially and
also
-from your "SizeEvent":sizeevent.html handler function.
</del><ins>+When defining your own scrollbar behaviour, you will
always need to
+recalculate the scrollbar settings when the window size changes. You
+could therefore put your scrollbar calculations and SetScrollbar call
+into a function named AdjustScrollbars, which can be called initially
+and also from your "SizeEvent":sizeevent.html handler function.
</ins><span class="cx">
</span><span class="cx"> h4. See also
</span><span class="cx">
</span><span class="lines">@@ -2469,63 +2484,22 @@
</span><span class="cx">
</span><span class="cx"> h3(#Window_setsize).
Window#set_size
</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)Size% size)
</ins><span class="cx">
</span><span class="cx"> *set_size*(%(arg-type)Rect%
rect)
</span><span class="cx">
</span><del>-Sets the size and position of the window in pixels.
</del><ins>+Sets the size of the window using either a
"Size":size.html or "Rect":rect.html
+object. The former just specifies the size of the window, in pixels; a
+rect specifies a new size and position.
</ins><span class="cx">
</span><del>- *set_size*(%(arg-type)Integer% width,
%(arg-type)Integer% height)
-
- *set_size*(%(arg-type)Size% size)
-
-Sets the size of the window in pixels.
-
</del><span class="cx"> h4. Parameters
</span><span class="cx">
</span><del>-* _x_ Required x position in pixels, or -1 to indicate
that the existing
-value should be used.
-* _y_ Required y position in pixels, or -1 to indicate that the existing
-value should be used.
-* _width_ Required width in pixels, or -1 to indicate that the existing
-value should be used.
-* _height_ Required height position in pixels, or -1 to indicate that the
existing
-value should be used.
</del><span class="cx"> * _size_
"Size":size.html object for setting the size.
</span><span class="cx"> * _rect_
"Rect":rect.html object for setting the position and size.
</span><del>-* _sizeFlags_ Indicates the interpretation of other
parameters. It is a bit list of the following:
</del><span class="cx">
</span><del>-*SIZE_AUTO_WIDTH*: a $-1$ width value is taken to
indicate
-a Widgets-supplied default width.
-
-*SIZE_AUTO_HEIGHT*: a $-1$ height value is taken to indicate
-a Widgets-supplied default width.\\
-*SIZE_AUTO*: -1 size values are taken to indicate
-a Widgets-supplied default size.\\
-*SIZE_USE_EXISTING*: existing dimensions should be used
-if -1 values are supplied.\\
-*SIZE_ALLOW_MINUS_ONE*: allow dimensions of $-1$ and less to be interpreted
-as real dimensions, not default values.
-*SIZE_FORCE*: normally, if the position and the size of the window are
-already the same as the parameters of this function, nothing is done. but with
-this flag a window resize may be forced even in this case (supported in wx
-2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
-
-
-h4. Remarks
-
-The second form is a convenience for calling the first form with default
-x and y parameters, and must be used with non-default width and height values.
-
-The first form sets the position and optionally size, of the window.
-Parameters may be -1 to indicate either that a default should be supplied
-by Widgets, or that the current value of the dimension should be used.
-
</del><span class="cx"> h4. See also
</span><span class="cx">
</span><del>-"Window#move":window.html#Window_move
</del><ins>+"Window:set_dimensions":#Window_setdimensions
, "Window#move":window.html#Window_move
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>
Apparently Analagous Threads
- [969] branches/wxruby2/wxwidgets_282/doc/textile/window.txtl: Cleanup and fixing of broken links.
- [778] trunk/wxruby2: Remove broken and deprecated LayoutConstraints, update samples & docs
- [840] trunk/wxruby2/doc/textile/boxsizer.txtl: Add methods listing, remove one bad link and not-for-user method descriptions
- [997] branches/wxruby2/wxwidgets_282: Window - 2.6 -> 2.8 API, new methods and deprecations; update doc
- [894] branches/wxruby2/wxwidgets_282/doc/textile/window.txtl: Document changed Window methods in 2.6 -> 2.8 API
Wisdom of the Ancients
