thr3ads.net - wxruby development - [Wxruby-development] [932] branches/wxruby2/wxwidgets_282/doc/textile/event.txtl: 2.8 updates and corrections to Event doc [Mar 2007]

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2007-Mar-30 07:53 UTC
[Wxruby-development] [932] branches/wxruby2/wxwidgets_282/doc/textile/event.txtl: 2.8 updates and corrections to Event doc

<!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>[932] branches/wxruby2/wxwidgets_282/doc/textile/event.txtl: 2.8
updates and corrections to Event doc</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>932</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2007-03-30 03:53:06 -0400 (Fri, 30 Mar
2007)</dd>
</dl>

<h3>Log Message</h3>
<pre>2.8 updates and corrections to Event doc</pre>

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

</div>
<div id="patch">
<h3>Diff</h3>
<a
id="brancheswxruby2wxwidgets_282doctextileeventtxtl"></a>
<div class="modfile"><h4>Modified:
branches/wxruby2/wxwidgets_282/doc/textile/event.txtl (931 => 932)</h4>
<pre class="diff"><span>
<span class="info">---
branches/wxruby2/wxwidgets_282/doc/textile/event.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2007-03-30
00:24:11 UTC (rev 931)
+++
branches/wxruby2/wxwidgets_282/doc/textile/event.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2007-03-30
07:53:06 UTC (rev 932)
</span><span class="lines">@@ -41,31 +41,13 @@
</span><span class="cx"> </div>
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_new). Event.new
</span><span class="cx"> 
</span><span class="cx">   *Event.new*(%(arg-type)Integer%
id = 0,  %(arg-type)EventType% eventType = @EVT_NULL@)
</span><span class="cx"> 
</span><span class="cx"> Constructor. Should not need to
be used directly by an application.
</span><span class="cx"> 
</span><del>-h3(#Event_mpropagationlevel).
Event#m__propagation_level
-
-intm_propagationLevel
-
-Indicates how many levels the event can propagate. This member is protected and
-should typically only be set in the constructors of the derived classes. It
-may be temporarily changed by
"stop_propagation":#Event_stoppropagation
-and "resume_propagation":#Event_resumepropagation and tested with 
-"should_propagate":#Event_shouldpropagate.
-
-The initial value is set to either @EVENT_PROPAGATE_NONE@ (by
-default) meaning that the event shouldn''t be propagated at all or to 
-@EVENT_PROPAGATE_MAX@ (for command events) meaning that it should be
-propagated as much as necessary.
-
-Any positive number means that the event should be propagated but no more than
-the given number of times. E.g. the propagation level may be set to $1$ to
-propagate the event to its parent only, but not to its grandparent.
-
</del><span class="cx"> h3(#Event_clone). Event#clone
</span><span class="cx"> 
</span><span class="cx">  "Event":event.html
*clone*()
</span><span class="lines">@@ -87,6 +69,7 @@
</span><span class="cx">      Event *Clone(void) const {
return new MyEvent(*this); }
</span><span class="cx">  
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_geteventobject).
Event#get_event_object
</span><span class="cx"> 
</span><span class="cx">  "Object":object.html
*get_event_object*()
</span><span class="lines">@@ -94,31 +77,39 @@
</span><span class="cx"> Returns the object (usually a
window) associated with the
</span><span class="cx"> event, if any.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_geteventtype).
Event#get_event_type
</span><span class="cx"> 
</span><del>- TYPE *get_event_type*()
</del><ins>+ Integer *get_event_type*()
</ins><span class="cx"> 
</span><del>-Returns the identifier of the given event type,
-such as EVENT_TYPE_BUTTON_COMMAND.
</del><ins>+Returns the integer identifier of the given event type,
such as
+@Wx::EVT_COMMAND_BUTTON_CLICKED@.
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_getid). Event#get_id
</span><span class="cx"> 
</span><span class="cx">  Integer *get_id*()
</span><span class="cx"> 
</span><span class="cx"> Returns the identifier associated
with this event, such as a button command id.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_getskipped).
Event#get_skipped
</span><span class="cx"> 
</span><span class="cx">  Boolean *get_skipped*()
</span><span class="cx"> 
</span><span class="cx"> Returns true if the event handler
should be skipped, false otherwise.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_gettimestamp).
Event#get_timestamp
</span><span class="cx"> 
</span><span class="cx">  Integer *get_timestamp*()
</span><span class="cx"> 
</span><del>-Gets the timestamp for the event.
</del><ins>+Gets the timestamp for the event. The timestamp is the
time in milliseconds
+since some fixed moment (not necessarily the standard Unix Epoch, so
+only differences between the timestamps and not their absolute values usually
+make sense).
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_iscommandevent).
Event#is_command_event
</span><span class="cx"> 
</span><span class="cx">  Boolean *is_command_event*()
</span><span class="lines">@@ -142,44 +133,54 @@
</span><span class="cx"> 
</span><span class="cx"> Sets the originating object.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_seteventtype).
Event#set_event_type
</span><span class="cx"> 
</span><del>-  *set_event_type*(%(arg-type)TYPE% typ)
</del><ins>+  *set_event_type*(%(arg-type)Integer% type)
</ins><span class="cx"> 
</span><del>-Sets the event type.
</del><ins>+Sets the event type, which should be one of the event
type constants,
+such as @Wx::EVT_COMMAND_BUTTON_CLICKED@.
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_setid). Event#set_id
</span><span class="cx"> 
</span><span class="cx">   *set_id*(%(arg-type)Integer%
id)
</span><span class="cx"> 
</span><span class="cx"> Sets the identifier associated
with this event, such as a button command id.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_settimestamp).
Event#set_timestamp
</span><span class="cx"> 
</span><span class="cx">  
*set_timestamp*(%(arg-type)Integer% timeStamp)
</span><span class="cx"> 
</span><span class="cx"> Sets the timestamp for the event.
</span><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_shouldpropagate).
Event#should_propagate
</span><span class="cx"> 
</span><span class="cx">  Boolean *should_propagate*()
</span><span class="cx"> 
</span><span class="cx"> Test if this event should be
propagated or not, i.e. if the propagation level
</span><del>-is currently greater than $0$.
</del><ins>+is currently greater than 0.
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_skip). Event#skip
</span><span class="cx"> 
</span><span class="cx">   *skip*(%(arg-type)Boolean% skip
= true)
</span><span class="cx"> 
</span><del>-Called by an event handler, it controls whether
additional event
-handlers bound to this event will be called after the current event
-handler returns.  Skip(false) (the default behavior) will prevent
-additional event handlers from being called and control will be
-returned to the sender of the event immediately after the current
-handler has finished.  Skip(true) will cause the event processing
-system to continue searching for a handler function for this event.
</del><ins>+This method can be used inside an event handler to
control whether further
+event handlers bound to this event will be called after the current one
+returns. Without skip() (or equivalently if skip(false) is used),
+the event will not be processed any more. If skip(true) is called, the event
+processing system continues searching for a further handler function for this
+event, even though it has been processed already in the current handler.
</ins><span class="cx"> 
</span><ins>+In general, it is recommended to skip all non-command
events to allow the
+default handling to take place. The command events are, however, normally not
+skipped as usually a single command such as a button click or menu item
+selection must only be processed by one handler.
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> h3(#Event_stoppropagation).
Event#stop_propagation
</span><span class="cx"> 
</span><span class="cx">  Integer *stop_propagation*()
</span></span></pre>
</div>
</div>

</body>
</html>
Reasonably Related Threads

Search for more reasonably related threads
wxruby development - Mar 2007 - [932] branches/wxruby2/wxwidgets_282/doc/textile/event.txtl: 2.8 updates and corrections to Event doc

[Wxruby-development] [932] branches/wxruby2/wxwidgets_282/doc/textile/event.txtl: 2.8 updates and corrections to Event doc

Reasonably Related Threads

Wisdom of the Ancients
