thr3ads.net - wxruby development - [Wxruby-development] [779] trunk/wxruby2: Added TreeCtrl#traverse method and documentation [Dec 2006]

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2006-Dec-05 19:07 UTC
[Wxruby-development] [779] trunk/wxruby2: Added TreeCtrl#traverse method and documentation

<!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>[779] trunk/wxruby2: Added TreeCtrl#traverse method and
documentation</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>779</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-12-05 14:07:34 -0500 (Tue, 05 Dec
2006)</dd>
</dl>

<h3>Log Message</h3>
<pre>Added TreeCtrl#traverse method and documentation</pre>

<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2doctextiletreectrltxtl">trunk/wxruby2/doc/textile/treectrl.txtl</a></li>
<li><a
href="#trunkwxruby2swigclassesTreeCtrli">trunk/wxruby2/swig/classes/TreeCtrl.i</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2doctextiletreectrltxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/treectrl.txtl (778 => 779)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/treectrl.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-03
17:30:10 UTC (rev 778)
+++
trunk/wxruby2/doc/textile/treectrl.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-05
19:07:34 UTC (rev 779)
</span><span class="lines">@@ -182,6 +182,7 @@
</span><span class="cx"> *
"TreeCtrl#sort_children":#TreeCtrl_sortchildren
</span><span class="cx"> *
"TreeCtrl#toggle":#TreeCtrl_toggle
</span><span class="cx"> *
"TreeCtrl#toggle_item_selection":#TreeCtrl_toggleitemselection
</span><ins>+* "TreeCtrl#traverse":#TreeCtrl_traverse
</ins><span class="cx"> *
"TreeCtrl#unselect":#TreeCtrl_unselect
</span><span class="cx"> *
"TreeCtrl#unselect_all":#TreeCtrl_unselectall
</span><span class="cx"> *
"TreeCtrl#unselect_item":#TreeCtrl_unselectitem
</span><span class="lines">@@ -981,7 +982,18 @@
</span><span class="cx"> Toggles the given item between
selected and unselected states. For
</span><span class="cx"> multiselection controls only.
</span><span class="cx"> 
</span><ins>+h3(#TreeCtrl_traverse). TreeCtrl#traverse
</ins><span class="cx"> 
</span><ins>+  *toggle_item_selection*(%(arg-type)TreeItemId%
start_item = root_id) { &#124; item_id &#124; ... }
+
+Recurses over the treectrl''s items, passing each TreeItemId
successively
+into the passed block. This TreeItemId can be used as an argument to
+many other methods in this class.
+
+The @start_item@ argument will be the first item_id passed into the
+block, followed by its children and descendants, depth first. If
+@start_item@ is not specified, it defaults to the root item of the tree.
+
</ins><span class="cx"> h3(#TreeCtrl_unselect).
TreeCtrl#unselect
</span><span class="cx"> 
</span><span class="cx">   *unselect*()
</span></span></pre></div>
<a id="trunkwxruby2swigclassesTreeCtrli"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/swig/classes/TreeCtrl.i (778 => 779)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/TreeCtrl.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-03
17:30:10 UTC (rev 778)
+++
trunk/wxruby2/swig/classes/TreeCtrl.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-05
19:07:34 UTC (rev 779)
</span><span class="lines">@@ -15,18 +15,10 @@
</span><span class="cx"> %{
</span><span class="cx"> class wxRbTreeItemData : public
wxTreeItemData {
</span><span class="cx"> public:
</span><del>-    wxRbTreeItemData(VALUE obj = Qnil) {
-        m_obj = obj;
-    }
-
-    VALUE GetRubyObject() {
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp   
return m_obj;
-    }
-
-    void SetRubyObject(VALUE obj) {
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp   
m_obj = obj;
-    }
-
</del><ins>+    wxRbTreeItemData(VALUE obj = Qnil) { m_obj = obj; }
+    VALUE GetRubyObject() { return m_obj; }
+    void SetRubyObject(VALUE obj) { m_obj = obj; }
+protected:
</ins><span class="cx">     VALUE m_obj;
</span><span class="cx"> };
</span><span class="cx"> %}
</span><span class="lines">@@ -51,20 +43,17 @@
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp 
$result = ruby_item_data->GetRubyObject();
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp}
</span><span class="cx"> }
</span><ins>+// End item data fixes
</ins><span class="cx"> 
</span><ins>+
</ins><span class="cx"> // GC handling for item data
objects
</span><span class="cx"> %{
</span><del>-  static void RecursivelyGCMarkFrom(wxTreeCtrl
*tree_ctrl, wxTreeItemId base_id )
</del><ins>+  // general recursion over a treectrl, starting from a
base_id
+  // the function rec_func will be called in turn for each tree item, 
+  // rec_func should be a funtion that receives a treectrl pointer and an
ItemId
+  static void RecurseOverTreeIds(wxTreeCtrl *tree_ctrl, const wxTreeItemId&
base_id, void(*rec_func)(void *, const wxTreeItemId&) )
</ins><span class="cx">   {
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//
check if there''s item data, and mark it
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxRbTreeItemData*
ruby_item_data = (wxRbTreeItemData *)tree_ctrl->GetItemData(base_id);
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif (
ruby_item_data != NULL )
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  {
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
ruby_obj = ruby_item_data->GetRubyObject();
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsprb_gc_mark(ruby_obj);
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  }
-
</del><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsprec_func(tree_ctrl,
base_id);
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//
recurse through children
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif (
tree_ctrl->ItemHasChildren(base_id) )
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  {
</span><span class="lines">@@ -72,12 +61,25 @@
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeItemId
child = tree_ctrl->GetFirstChild(base_id, cookie);
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwhile
( child.IsOk() )
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
{
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspRecursivelyGCMarkFrom(tree_ctrl,
child);
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspchild
= tree_ctrl->GetNextSibling(child);
</del><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspRecurseOverTreeIds(tree_ctrl,
child, *rec_func);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspchild
= tree_ctrl->GetNextChild(base_id, cookie);
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
}
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  }
</span><span class="cx">   }
</span><span class="cx"> 
</span><ins>+  static void DoGCMarkItemData(void *ptr, const
wxTreeItemId& item_id)
+  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeCtrl*
tree_ctrl = (wxTreeCtrl*) ptr;
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//
check if there''s item data, and mark it
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxRbTreeItemData*
ruby_item_data = (wxRbTreeItemData *)tree_ctrl->GetItemData(item_id);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif (
ruby_item_data != NULL )
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
ruby_obj = ruby_item_data->GetRubyObject();
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsprb_gc_mark(ruby_obj);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  }
+  }
+
+  // SWIG''s entry point function for GC mark
</ins><span class="cx">   static void mark_wxTreeCtrl(void
*ptr)
</span><span class="cx">   {
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
rb_obj = SWIG_RubyInstanceFor(ptr);
</span><span class="lines">@@ -86,8 +88,17 @@
</span><span class="cx"> 
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeCtrl*
tree_ctrl = (wxTreeCtrl*) ptr;
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeItemId
root_id = tree_ctrl->GetRootItem();
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspRecursivelyGCMarkFrom(tree_ctrl,
root_id);
</del><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspRecurseOverTreeIds(tree_ctrl,
root_id, &DoGCMarkItemData);
</ins><span class="cx">   }
</span><ins>+
+  // function for internal implementation of TreeCtrl#traverse 
+  static void DoTreeCtrlYielding(void *ptr, const wxTreeItemId& item_id)
+  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//
create a copy to wrap and give to ruby
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeItemId
*copy_id = new wxTreeItemId(item_id.m_pItem);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
rb_item_id = SWIG_NewPointerObj(copy_id, SWIGTYPE_p_wxTreeItemId,
SWIG_POINTER_OWN);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsprb_yield(rb_item_id);
+  }
</ins><span class="cx"> %}
</span><span class="cx"> %markfunc wxTreeCtrl
"mark_wxTreeCtrl";
</span><span class="cx"> 
</span><span class="lines">@@ -105,7 +116,24 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> %extend wxTreeCtrl {
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
</del><ins>+
+  VALUE traverse(const wxTreeItemId& item_id = wxTreeItemId() )
+  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxTreeItemId
base_id;
+
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif (
item_id.IsOk() )
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspbase_id
= item_id;
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  }
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspelse
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  {
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspbase_id
= self->GetRootItem();
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  }
+
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspRecurseOverTreeIds(self,
base_id, &DoTreeCtrlYielding);
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspreturn
Qnil;
+  }
+
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//Change
signature so it returns an array of the TreeItemId and the Cookie.
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp//This
behavior matches that used by wxPython and wxPerl.
</span><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
get_first_child(const wxTreeItemId& item)
</span></span></pre>
</div>
</div>

</body>
</html>
Seemingly Similar Threads

Search for more seemingly similar threads
wxruby development - Dec 2006 - [779] trunk/wxruby2: Added TreeCtrl#traverse method and documentation

[Wxruby-development] [779] trunk/wxruby2: Added TreeCtrl#traverse method and documentation

Seemingly Similar Threads

Wisdom of the Ancients
