summaryrefslogtreecommitdiff
path: root/doc/classes/Editor.html
blob: 0e3a4dbfd3da4e473fdef38c8d8242d570f745a0 (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
<?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>Module: Editor</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>Module</strong></td>
          <td class="class-name-in-header">Editor</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">



   </div>

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

      <div class="name-list">
      <a href="#M000086">data2model</a>&nbsp;&nbsp;
      <a href="#M000083">error_dialog</a>&nbsp;&nbsp;
      <a href="#M000082">fetch_icon</a>&nbsp;&nbsp;
      <a href="#M000085">model2data</a>&nbsp;&nbsp;
      <a href="#M000084">question_dialog</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





      


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

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

        <div class="method-heading">
          <a href="Editor.src/M000086.html" target="Code" class="method-signature"
            onclick="popupCode('Editor.src/M000086.html');return false;">
          <span class="method-name">data2model</span><span class="method-args">(data, model = nil, parent = nil) {|model| ...}</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Convert the Ruby data structure <em>data</em> into tree model data for <a
href="Gtk.html">Gtk</a> and returns the whole model. If the parameter
<em>model</em> wasn&#8216;t given a new Gtk::TreeStore is created as the
model. The <em>parent</em> parameter specifies the parent node (iter, <a
href="Gtk.html">Gtk</a>:TreeIter instance) to which the data is appended,
alternativeley the result of the yielded block is used as iter.
</p>
        </div>
      </div>

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

        <div class="method-heading">
          <a href="Editor.src/M000083.html" target="Code" class="method-signature"
            onclick="popupCode('Editor.src/M000083.html');return false;">
          <span class="method-name">error_dialog</span><span class="method-args">(window, text)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Opens an error dialog on top of <em>window</em> showing the error message
<em>text</em>.
</p>
        </div>
      </div>

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

        <div class="method-heading">
          <a href="Editor.src/M000082.html" target="Code" class="method-signature"
            onclick="popupCode('Editor.src/M000082.html');return false;">
          <span class="method-name">fetch_icon</span><span class="method-args">(name)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns the Gdk::Pixbuf of the icon named <em>name</em> from the icon
cache.
</p>
        </div>
      </div>

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

        <div class="method-heading">
          <a href="Editor.src/M000085.html" target="Code" class="method-signature"
            onclick="popupCode('Editor.src/M000085.html');return false;">
          <span class="method-name">model2data</span><span class="method-args">(iter)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Convert the tree model starting from <a
href="Gtk/TreeIter.html">Gtk::TreeIter</a> <em>iter</em> into a Ruby data
structure and return it.
</p>
        </div>
      </div>

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

        <div class="method-heading">
          <a href="Editor.src/M000084.html" target="Code" class="method-signature"
            onclick="popupCode('Editor.src/M000084.html');return false;">
          <span class="method-name">question_dialog</span><span class="method-args">(window, text)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Opens a yes/no question dialog on top of <em>window</em> showing the error
message <em>text</em>. If yes was answered <em>true</em> is returned,
otherwise <em>false</em>.
</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>