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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkrecentchoosermenu">
<refnamediv>
<refname>gtk.RecentChooserMenu</refname>
<refpurpose>Displays recently used files in a menu (new in PyGTK
2.10)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.RecentChooserMenu</classname></ooclass>
<ooclass><classname><link linkend="class-gtkmenu">gtk.Menu</link></classname></ooclass>
<ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkrecentchoosermenu">gtk.RecentChooserMenu</link></methodname>
<methodparam><parameter role="keyword">manager</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrecentchoosermenu--get-show-numbers">get_show_numbers</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrecentchoosermenu--set-show-numbers">set_show_numbers</link></methodname>
<methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkmenushell">gtk.MenuShell</link>
+-- <link linkend="class-gtkmenu">gtk.Menu</link>
+-- <link linkend="class-gtkrecentchoosermenu">gtk.RecentChooserMenu</link> (implements <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>)
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkrecentchoosermenu">
<title>gtk.RecentChooserMenu Properties</title>
<para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkmenushell">gtk.MenuShell Properties</link></para>
<para><link linkend="properties-gtkmenu">gtk.Menu Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"show-numbers"</entry>
<entry>Read-Write</entry>
<entry>Whether the first ten items in the menu should be prepended by
a number acting as a unique mnemonic.
This property is available in GTK+ 2.10 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkrecentchoosermenu">
<title>gtk.RecentChooserMenu Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkmenu">gtk.Menu Style Properties</link></para>
</refsect1>
<refsect1 id="child-properties-gtkrecentchoosermenu">
<title>gtk.RecentChooserMenu Child Properties</title>
<para><link linkend="child-properties-gtkmenu">gtk.Menu Child Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkrecentchoosermenu">
<title>gtk.RecentChooserMenu Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkmenushell">gtk.MenuShell Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkmenu">gtk.Menu Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> is a widget suitable for displaying recently used files
inside a menu. It can be used to set a sub-menu of a <link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> using
<link linkend="method-gtkmenuitem--set-submenu"><methodname>gtk.MenuItem.set_submenu()</methodname></link>, or as the menu of a <link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>.
</para>
<para>
Note that <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> does not have any methods of its own. Instead,
you should use the functions that work on a <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.
</para>
<para>
Recently used files are supported since GTK+ 2.10.
</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gtkrecentchoosermenu">
<title>gtk.RecentChooserMenu</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.RecentChooserMenu</methodname>
<methodparam><parameter role="keyword">manager</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">manager</parameter> :</term>
<listitem><simpara>a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>, bound to <parameter>manager</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.10 and above.</para>
</note>
<para>Creates a new <link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link> widget using <parameter>manager</parameter> as
the underlying recently used resources manager.</para>
<para>This is useful if you have implemented your own recent manager,
or if you have a customized instance of a <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
object or if you wish to share a common <link linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link> object
among multiple <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link> widgets.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkrecentchoosermenu--get-show-numbers">
<title>gtk.RecentChooserMenu.get_show_numbers</title>
<programlisting><methodsynopsis language="python">
<methodname>get_show_numbers</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if numbers should be shown.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>Returns the value set by <link linkend="method-gtkrecentchoosermenu--set-show-numbers"><methodname>gtk.RecentChooserMenu.set_show_numbers()</methodname></link>.</para>
</refsect2>
<refsect2 id="method-gtkrecentchoosermenu--set-show-numbers">
<title>gtk.RecentChooserMenu.set_show_numbers</title>
<programlisting><methodsynopsis language="python">
<methodname>set_show_numbers</methodname>
<methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">show_numbers</parameter> :</term>
<listitem><simpara>whether to show numbers</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>Sets whether a number should be added to the items of <parameter>menu</parameter>. The
numbers are shown to provide a unique character for a mnemonic to
be used inside the menu item's label. Only the first the items
get a number to avoid clashes.</para>
</refsect2>
</refsect1>
</refentry>
|