thr3ads.net - wxruby development - [Wxruby-development] [699] trunk/wxruby2/doc/textile/window.txtl: Added paint method; corrected ret values for get_text

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2006-Oct-21 14:45 UTC
[Wxruby-development] [699] trunk/wxruby2/doc/textile/window.txtl: Added paint method; corrected ret values for get_text_extent; removed

<!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>[699] trunk/wxruby2/doc/textile/window.txtl: Added paint method;
corrected ret values for get_text_extent; removed</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>699</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-10-21 10:45:10 -0400 (Sat, 21 Oct
2006)</dd>
</dl>

<h3>Log Message</h3>
<pre>Added paint method; corrected ret values for get_text_extent; removed
some C++ specific info.</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 (698 => 699)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/window.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-10-21
14:23:39 UTC (rev 698)
+++
trunk/wxruby2/doc/textile/window.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-10-21
14:45:10 UTC (rev 699)
</span><span class="lines">@@ -4,23 +4,10 @@
</span><span class="cx"> screen. All controls, top level
windows and so on are windows. Sizers and
</span><span class="cx"> device contexts are not, however,
as they don''t appear on screen themselves.
</span><span class="cx"> 
</span><del>-Please note that all children of the window will be
deleted automatically by
-the destructor before the window itself is deleted which means that you
don''t
-have to worry about deleting them manually. Please see the "window
-deletion overview":windowdeletionoverview.html for more information.
</del><ins>+Please note that all children of the window will be
deleted
+automatically before the window itself is deleted which means that you
+don''t have to worry about deleting them manually.
</ins><span class="cx"> 
</span><del>-Also note that in this, and many others, Widgets
classes some
-@GetXXX()@ methods may be overloaded (as, for example,
-"get_size":#Window_getsize or
-"get_client_size":#Window_getclientsize). In this case, the overloads
-are non-virtual because having multiple virtual functions with the same name
-results in a virtual function name hiding at the derived class level (in
-English, this means that the derived class has to override all overloaded
-variants if it overrides any of them). To allow overriding them in the derived
-class, Widgets uses a unique protected virtual @DoGetXXX()@ method
-and all @GetXXX()@ ones are forwarded to it, so overriding the former
-changes the behaviour of the latter.
-
</del><span class="cx"> h2. Derived from
</span><span class="cx"> 
</span><span class="cx">
"EvtHandler":evthandler.html
</span><span class="lines">@@ -432,8 +419,8 @@
</span><span class="cx"> 
</span><span class="cx"> h4. Parameters
</span><span class="cx"> 
</span><del>-* _force_ @false@ if the window''s close
handler should be able to veto the destruction
-of this window, @true@ if it cannot.
</del><ins>+* _force_ @false@ if the window''s close handler
should be able to veto
+  the destruction of this window, @true@ if it cannot.
</ins><span class="cx"> 
</span><span class="cx"> h4. Remarks
</span><span class="cx"> 
</span><span class="lines">@@ -1188,10 +1175,6 @@
</span><span class="cx"> * _width_ Receives the window
width.
</span><span class="cx"> * _height_ Receives the window
height.
</span><span class="cx"> 
</span><del>-
-
-
-
</del><span class="cx"> h4. See also
</span><span class="cx"> 
</span><span class="cx">
"get_client_size":#Window_getclientsize,
"get_virtual_size":#Window_getvirtualsize
</span><span class="lines">@@ -1207,30 +1190,27 @@
</span><span class="cx"> 
</span><span class="cx"> h3(#Window_gettextextent).
Window#get_text_extent
</span><span class="cx"> 
</span><del>-  *get_text_extent*(%(arg-type)String% string, 
%(arg-type)Integer% x,  %(arg-type)Integer% y,
-                  %(arg-type)Integer% descent = nil, 
-                  %(arg-type)Integer% externalLeading = nil, 
-                  %(arg-type)Font% font = nil, 
-                  %(arg-type)Boolean% use16 = @false@)
</del><ins>+ Integer x, Integer y, Integer descent, Integer
external_leading =
+   *get_text_extent*(%(arg-type)String% string, %(arg-type)Font% font = nil,
%(arg-type)Boolean% use16 = @false@)
</ins><span class="cx"> 
</span><span class="cx"> Gets the dimensions of the string
as it would be drawn on the
</span><del>-window with the currently selected font.
</del><ins>+window with the currently selected font. The dimensions
are returned as
+a four-element array. 
</ins><span class="cx"> 
</span><ins>+The first two elements are the width and height, in
pixels, of the
+string. The third and fourth values are the descent and external
+leading - which are not normally needed.
+
+The @font@ parameter may optionally be passed to specify the font and
+size for which the dimensions of the string will be calculated. If this
+parameter is not passed, the current window font is used.
+
</ins><span class="cx"> h4. Parameters
</span><span class="cx"> 
</span><span class="cx"> * _string_ String whose extent is
to be measured.
</span><del>-* _x_ Return value for width.
-* _y_ Return value for height.
-* _descent_ Return value for descent (optional).
-* _externalLeading_ Return value for external leading (optional).
</del><span class="cx"> * _font_ Font to use instead of
the current window font (optional).
</span><span class="cx"> * _use16_ If @true@, _string_
contains 16-bit characters. The default is @false@.
</span><span class="cx"> 
</span><del>-
-
-
-
-
</del><span class="cx"> h3(#Window_gettitle).
Window#get_title
</span><span class="cx"> 
</span><span class="cx">  String *get_title*()
</span><span class="lines">@@ -1585,14 +1565,23 @@
</span><span class="cx"> 
</span><span class="cx"> h3(#Window_pagedown).
Window#page_down
</span><span class="cx"> 
</span><del>-This is just a wrapper for
"scroll_pages()":#Window_scrollpages()$(1)$.
</del><ins>+This is just a convenience wrapper for
+"scroll_pages(1)":#Window_scrollpages . It scrolls the window down
one page
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> h3(#Window_pageup).
Window#page_up
</span><span class="cx"> 
</span><del>-This is just a wrapper for
"scroll_pages()":#Window_scrollpages()$(-1)$.
</del><ins>+This is just a convenience wrapper for
+"scroll_pages(-1)":#Window_scrollpages . It scrolls the window up one
page.
</ins><span class="cx"> 
</span><span class="cx"> 
</span><ins>+h3(#Window_paint). Window#paint
+
+ paint { | window_dc | ... }
+
+This method runs the block, yielding a "WindowDC":windowdc.html into
it
+to enable direct drawing onto a widget.
+
</ins><span class="cx"> h3(#Window_popeventhandler).
Window#pop_event_handler
</span><span class="cx"> 
</span><span class="cx"> 
"EvtHandler":evthandler.html *pop_event_handler*(%(arg-type)Boolean%
deleteHandler = @false@)
</span></span></pre>
</div>
</div>

</body>
</html>
Seemingly Similar Threads

Search for more apparently analagous threads
wxruby development - Oct 2006 - [699] trunk/wxruby2/doc/textile/window.txtl: Added paint method; corrected ret values for get_text_extent; removed

[Wxruby-development] [699] trunk/wxruby2/doc/textile/window.txtl: Added paint method; corrected ret values for get_text_extent; removed

Seemingly Similar Threads

Wisdom of the Ancients
