summaryrefslogtreecommitdiff
path: root/doc/classes/JSONTreeView.html
blob: 9f01bbfaa406eef5c93ec6f8a7f786ca78e75de3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: JSONTreeView</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">JSONTreeView</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/json/editor_rb.html">
                lib/json/editor.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Gtk::TreeView
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
This class inherits from Gtk::TreeView, to configure it and to add a lot of
behaviour to it.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000038">ask_for_element</a>&nbsp;&nbsp;
      <a href="#M000040">ask_for_find_term</a>&nbsp;&nbsp;
      <a href="#M000037">ask_for_hash_pair</a>&nbsp;&nbsp;
      <a href="#M000039">ask_for_order</a>&nbsp;&nbsp;
      <a href="#M000036">create_node</a>&nbsp;&nbsp;
      <a href="#M000041">expand_collapse</a>&nbsp;&nbsp;
      <a href="#M000035">new</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name"><a href="Gtk.html">Gtk</a></span>
      </div>
    </div>

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">expanded</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
Returns true, if nodes are autoexpanding, false otherwise.

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">window</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc">
Returns the <a href="MainWindow.html">MainWindow</a> instance of this <a
href="JSONTreeView.html">JSONTreeView</a>.

</td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000035" class="method-detail">
        <a name="M000035"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000035.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000035.html');return false;">
          <span class="method-name">new</span><span class="method-args">(window)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates a <a href="JSONTreeView.html">JSONTreeView</a> instance, the
parameter <em>window</em> is a <a href="MainWindow.html">MainWindow</a>
instance and used for self delegation.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000038" class="method-detail">
        <a name="M000038"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000038.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000038.html');return false;">
          <span class="method-name">ask_for_element</span><span class="method-args">(parent = nil, default_type = nil, value_text = @content)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Ask for an element to be appended <em>parent</em>.
</p>
        </div>
      </div>

      <div id="method-M000040" class="method-detail">
        <a name="M000040"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000040.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000040.html');return false;">
          <span class="method-name">ask_for_find_term</span><span class="method-args">(search = nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Ask for a find term to search for in the tree. Returns the term as a
string.
</p>
        </div>
      </div>

      <div id="method-M000037" class="method-detail">
        <a name="M000037"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000037.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000037.html');return false;">
          <span class="method-name">ask_for_hash_pair</span><span class="method-args">(parent)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Ask for a hash key, value pair to be added to the Hash node
<em>parent</em>.
</p>
        </div>
      </div>

      <div id="method-M000039" class="method-detail">
        <a name="M000039"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000039.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000039.html');return false;">
          <span class="method-name">ask_for_order</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Ask for an order criteria for sorting, using <em>x</em> for the element in
question. Returns the order criterium, and true/false for reverse sorting.
</p>
        </div>
      </div>

      <div id="method-M000036" class="method-detail">
        <a name="M000036"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000036.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000036.html');return false;">
          <span class="method-name">create_node</span><span class="method-args">(parent, type, content)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Create a <em>type</em> node with content <em>content</em>, and add it to
<em>parent</em> in the model. If <em>parent</em> is nil, create a <a
href="JSONTreeView.html#M000035">new</a> model and put it into the editor
treeview.
</p>
        </div>
      </div>

      <div id="method-M000041" class="method-detail">
        <a name="M000041"></a>

        <div class="method-heading">
          <a href="JSONTreeView.src/M000041.html" target="Code" class="method-signature"
            onclick="popupCode('JSONTreeView.src/M000041.html');return false;">
          <span class="method-name">expand_collapse</span><span class="method-args">(iter)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Expand or collapse row pointed to by <em>iter</em> according to the
expanded attribute.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>