diff options
Diffstat (limited to 'doc/JSON/Editor/MenuExtension.html')
| -rw-r--r-- | doc/JSON/Editor/MenuExtension.html | 516 |
1 files changed, 516 insertions, 0 deletions
diff --git a/doc/JSON/Editor/MenuExtension.html b/doc/JSON/Editor/MenuExtension.html new file mode 100644 index 0000000..8bfb2d7 --- /dev/null +++ b/doc/JSON/Editor/MenuExtension.html @@ -0,0 +1,516 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> + + <title>Module: JSON::Editor::MenuExtension</title> + + <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" /> + + <script src="../../js/jquery.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../js/thickbox-compressed.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../js/quicksearch.js" type="text/javascript" + charset="utf-8"></script> + <script src="../../js/darkfish.js" type="text/javascript" + charset="utf-8"></script> + +</head> +<body class="module"> + + <div id="metadata"> + <div id="file-metadata"> + <div id="file-list-section" class="section"> + <h3 class="section-header">In Files</h3> + <div class="section-body"> + <ul> + + <li><a href="../../lib/json/editor_rb.html?TB_iframe=true&height=550&width=785" + class="thickbox" title="lib/json/editor.rb">lib/json/editor.rb</a></li> + + </ul> + </div> + </div> + + + </div> + + <div id="class-metadata"> + + <!-- Parent Class --> + + + <!-- Namespace Contents --> + + + <!-- Method Quickref --> + + <div id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + <ul class="link-list"> + + <li><a href="#M000091">::new</a></li> + + <li><a href="#M000093">#add_item</a></li> + + <li><a href="#M000092">#add_separator</a></li> + + <li><a href="#M000094">#create</a></li> + + <li><a href="#M000095">#method_missing</a></li> + + </ul> + </div> + + + <!-- Included Modules --> + + <div id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + <ul class="link-list"> + + + <li><a class="include" href="MenuExtension.html">JSON::Editor::MenuExtension</a></li> + + + </ul> + </div> + + </div> + + <div id="project-metadata"> + + + <div id="fileindex-section" class="section project-section"> + <h3 class="section-header">Files</h3> + <ul> + + <li class="file"><a href="../../doc-main_txt.html">doc-main.txt</a></li> + + </ul> + </div> + + + <div id="classindex-section" class="section project-section"> + <h3 class="section-header">Class Index + <span class="search-toggle"><img src="../../images/find.png" + height="16" width="16" alt="[+]" + title="show/hide quicksearch" /></span></h3> + <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> + <fieldset> + <legend>Quicksearch</legend> + <input type="text" name="quicksearch" value="" + class="quicksearch-field" /> + </fieldset> + </form> + + <ul class="link-list"> + + <li><a href="../../JSON.html">JSON</a></li> + + <li><a href="../../JSON/CircularDatastructure.html">JSON::CircularDatastructure</a></li> + + <li><a href="../../JSON/Editor.html">JSON::Editor</a></li> + + <li><a href="../../JSON/Editor/EditMenu.html">JSON::Editor::EditMenu</a></li> + + <li><a href="../../JSON/Editor/FileMenu.html">JSON::Editor::FileMenu</a></li> + + <li><a href="../../JSON/Editor/Gtk.html">JSON::Editor::Gtk</a></li> + + <li><a href="../../JSON/Editor/Gtk/TreeIter.html">JSON::Editor::Gtk::TreeIter</a></li> + + <li><a href="../../JSON/Editor/JSONTreeView.html">JSON::Editor::JSONTreeView</a></li> + + <li><a href="../../JSON/Editor/MainWindow.html">JSON::Editor::MainWindow</a></li> + + <li><a href="../../JSON/Editor/MenuExtension.html">JSON::Editor::MenuExtension</a></li> + + <li><a href="../../JSON/Editor/OptionsMenu.html">JSON::Editor::OptionsMenu</a></li> + + <li><a href="../../JSON/Editor/PopUpMenu.html">JSON::Editor::PopUpMenu</a></li> + + <li><a href="../../JSON/Ext.html">JSON::Ext</a></li> + + <li><a href="../../JSON/Ext/Generator.html">JSON::Ext::Generator</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods.html">JSON::Ext::Generator::GeneratorMethods</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/Array.html">JSON::Ext::Generator::GeneratorMethods::Array</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/FalseClass.html">JSON::Ext::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/Float.html">JSON::Ext::Generator::GeneratorMethods::Float</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/Hash.html">JSON::Ext::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/Integer.html">JSON::Ext::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/NilClass.html">JSON::Ext::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/Object.html">JSON::Ext::Generator::GeneratorMethods::Object</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/String.html">JSON::Ext::Generator::GeneratorMethods::String</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/String/Extend.html">JSON::Ext::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="../../JSON/Ext/Generator/GeneratorMethods/TrueClass.html">JSON::Ext::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="../../JSON/Ext/Generator/State.html">JSON::Ext::Generator::State</a></li> + + <li><a href="../../JSON/Ext/Parser.html">JSON::Ext::Parser</a></li> + + <li><a href="../../JSON/GeneratorError.html">JSON::GeneratorError</a></li> + + <li><a href="../../JSON/JSONError.html">JSON::JSONError</a></li> + + <li><a href="../../JSON/MissingUnicodeSupport.html">JSON::MissingUnicodeSupport</a></li> + + <li><a href="../../JSON/NestingError.html">JSON::NestingError</a></li> + + <li><a href="../../JSON/ParserError.html">JSON::ParserError</a></li> + + <li><a href="../../JSON/Pure.html">JSON::Pure</a></li> + + <li><a href="../../JSON/Pure/Generator.html">JSON::Pure::Generator</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods.html">JSON::Pure::Generator::GeneratorMethods</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/Array.html">JSON::Pure::Generator::GeneratorMethods::Array</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/FalseClass.html">JSON::Pure::Generator::GeneratorMethods::FalseClass</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/Float.html">JSON::Pure::Generator::GeneratorMethods::Float</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/Hash.html">JSON::Pure::Generator::GeneratorMethods::Hash</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/Integer.html">JSON::Pure::Generator::GeneratorMethods::Integer</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/NilClass.html">JSON::Pure::Generator::GeneratorMethods::NilClass</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/Object.html">JSON::Pure::Generator::GeneratorMethods::Object</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/String.html">JSON::Pure::Generator::GeneratorMethods::String</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/String/Extend.html">JSON::Pure::Generator::GeneratorMethods::String::Extend</a></li> + + <li><a href="../../JSON/Pure/Generator/GeneratorMethods/TrueClass.html">JSON::Pure::Generator::GeneratorMethods::TrueClass</a></li> + + <li><a href="../../JSON/Pure/Generator/State.html">JSON::Pure::Generator::State</a></li> + + <li><a href="../../JSON/Pure/Parser.html">JSON::Pure::Parser</a></li> + + <li><a href="../../Class.html">Class</a></li> + + <li><a href="../../Date.html">Date</a></li> + + <li><a href="../../DateTime.html">DateTime</a></li> + + <li><a href="../../Enumerable.html">Enumerable</a></li> + + <li><a href="../../Exception.html">Exception</a></li> + + <li><a href="../../Kernel.html">Kernel</a></li> + + <li><a href="../../Object.html">Object</a></li> + + <li><a href="../../Range.html">Range</a></li> + + <li><a href="../../Regexp.html">Regexp</a></li> + + <li><a href="../../Struct.html">Struct</a></li> + + <li><a href="../../Symbol.html">Symbol</a></li> + + <li><a href="../../Time.html">Time</a></li> + + </ul> + <div id="no-class-search-results" style="display: none;">No matching classes.</div> + </div> + + + </div> + </div> + + <div id="documentation"> + <h1 class="module">JSON::Editor::MenuExtension</h1> + + <div id="description"> + <p> +This module bundles some method, that can be used to create a menu. It +should be included into the class in question. +</p> + + </div> + + <!-- Constants --> + + + <!-- Attributes --> + + <div id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="treeview-attribute-method" class="method-detail"> + <a name="treeview"></a> + + <div class="method-heading attribute-method-heading"> + <span class="method-name">treeview</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p> +Returns the Gtk::TreeView of this menu. +</p> + + </div> + </div> + + <div id="menu-attribute-method" class="method-detail"> + <a name="menu"></a> + + <div class="method-heading attribute-method-heading"> + <span class="method-name">menu</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + <p> +Returns the menu. +</p> + + </div> + </div> + + </div> + + + <!-- Methods --> + + <div id="public-class-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="new-method" class="method-detail "> + <a name="M000091"></a> + + <div class="method-heading"> + + <span class="method-name">new</span><span + class="method-args">(treeview)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Creates a Menu, that includes <a +href="MenuExtension.html">MenuExtension</a>. <em>treeview</em> is the +Gtk::TreeView, on which it operates. +</p> + + + + <div class="method-source-code" + id="new-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/editor.rb, line 212</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">treeview</span>) + <span class="ruby-ivar">@treeview</span> = <span class="ruby-identifier">treeview</span> + <span class="ruby-ivar">@menu</span> = <span class="ruby-constant">Menu</span>.<span class="ruby-identifier">new</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + </div> + + <div id="public-instance-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="add-item-method" class="method-detail "> + <a name="M000093"></a> + + <div class="method-heading"> + + <span class="method-name">add_item</span><span + class="method-args">(label, keyval = nil, klass = MenuItem, &callback)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Adds a Gtk::MenuItem to this instance’s <a +href="MenuExtension.html#menu">menu</a>. <em>label</em> is the label +string, <em>klass</em> is the item type, and <em>callback</em> is the +procedure, that is called if the <em>item</em> is activated. +</p> + + + + <div class="method-source-code" + id="add-item-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/editor.rb, line 231</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_item</span>(<span class="ruby-identifier">label</span>, <span class="ruby-identifier">keyval</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">klass</span> = <span class="ruby-constant">MenuItem</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">callback</span>) + <span class="ruby-identifier">label</span> = <span class="ruby-node">"#{label} (C-#{keyval.chr})"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keyval</span> + <span class="ruby-identifier">item</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">label</span>) + <span class="ruby-identifier">item</span>.<span class="ruby-identifier">signal_connect</span>(<span class="ruby-identifier">:activate</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">callback</span>) + <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">keyval</span> + <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">signal_connect</span>(<span class="ruby-identifier">:'key-press-event'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span>, <span class="ruby-identifier">event</span><span class="ruby-operator">|</span> + <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">state</span> <span class="ruby-operator">&</span> <span class="ruby-constant">Gdk</span><span class="ruby-operator">::</span><span class="ruby-constant">Window</span><span class="ruby-operator">::</span><span class="ruby-constant">ModifierType</span><span class="ruby-operator">::</span><span class="ruby-constant">CONTROL_MASK</span> <span class="ruby-operator">!=</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">and</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">keyval</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">keyval</span> + <span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">item</span> + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">end</span> + <span class="ruby-keyword kw">end</span> + <span class="ruby-identifier">menu</span>.<span class="ruby-identifier">append</span> <span class="ruby-identifier">item</span> + <span class="ruby-identifier">item</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="add-separator-method" class="method-detail "> + <a name="M000092"></a> + + <div class="method-heading"> + + <span class="method-name">add_separator</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +Adds a Gtk::SeparatorMenuItem to this instance’s <a +href="MenuExtension.html#menu">menu</a>. +</p> + + + + <div class="method-source-code" + id="add-separator-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/editor.rb, line 224</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_separator</span> + <span class="ruby-identifier">menu</span>.<span class="ruby-identifier">append</span> <span class="ruby-constant">SeparatorMenuItem</span>.<span class="ruby-identifier">new</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="create-method" class="method-detail "> + <a name="M000094"></a> + + <div class="method-heading"> + + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p> +This method should be implemented in subclasses to create the <a +href="MenuExtension.html#menu">menu</a> of this instance. It has to be +called after an instance of this class is created, to build the menu. +</p> + + + + <div class="method-source-code" + id="create-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/editor.rb, line 250</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span> + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + <div id="method-missing-method" class="method-detail "> + <a name="M000095"></a> + + <div class="method-heading"> + + <span class="method-name">method_missing</span><span + class="method-args">(*a, &b)</span> + <span class="method-click-advice">click to toggle source</span> + + </div> + + <div class="method-description"> + + <p class="missing-docs">(Not documented)</p> + + + + <div class="method-source-code" + id="method-missing-source"> +<pre> +<span class="ruby-comment cmt"># File lib/json/editor.rb, line 254</span> + <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>) + <span class="ruby-identifier">treeview</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">a</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>) + <span class="ruby-keyword kw">end</span></pre> + </div> + + </div> + + + </div> + + + </div> + + + </div> + + + <div id="rdoc-debugging-section-dump" class="debugging-section"> + + <p>Disabled; run with --debug to generate this.</p> + + </div> + + <div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> + <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish + Rdoc Generator</a> 1.1.6</small>.</p> + </div> + +</body> +</html> + |