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
|
<?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-thunarx-python-menu-provider">
<refnamediv>
<refname>Thunarx.MenuProvider</refname>
<refpurpose>Thunarx.MenuProvider Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
<!-- BEGIN OF SYNOPSIS -->
<!-- ******************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>Thunarx.MenuProvider</classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-provider--get-file-menu-items">get_file_menu_items</link></methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">files</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-provider--get-folder-menu-items">get_folder_menu_items</link></methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">folder</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-provider--get-dnd-menu-items">get_dnd_menu_items</link></methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">folder</parameter></methodparam>
<methodparam><parameter role="keyword">files</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ********************************** -->
<!-- BEGIN OF DESCRIPTION -->
<!-- ********************************** -->
<refsect1 id="description-menu-provider">
<title>Description</title>
<para>
The interface to extensions that provide additional menu items
</para>
</refsect1>
<example>
<title>A Thunarx.MenuProvider plugin (without submenus)</title>
<programlisting>
from gi.repository import GObject, Gtk, Thunarx
class ThunarxMenuProviderPlugin(GObject.GObject, Thunarx.MenuProvider):
def __init__(self):
pass
def get_file_menu_items(self, window, files):
item = Thunarx.MenuItem(name="TMP:TestFileAction", label="Python File Action", tooltip='', icon=Gtk.STOCK_FILE)
item.connect("activate", self.__do_something, window)
return [item]
def get_folder_menu_items(self, window, folder):
return [Thunarx.MenuItem(name="TMP:TestFolderAction", label="Python Folder Action", tooltip='', icon=Gtk.STOCK_OPEN)]
def __do_something(self, item, window):
print("Doing something")
</programlisting>
</example>
<example>
<title>A Thunarx.MenuProvider plugin (with submenus)</title>
<programlisting>
from gi.repository import GObject, Gtk, Thunarx
class ThunarxSubMenuProviderPlugin(GObject.GObject, Thunarx.MenuProvider):
def __init__(self):
pass
def get_file_menu_items(self, window, files):
item = Thunarx.MenuItem(name="TMP:Item1", label="Python File Action", tooltip='', icon=Gtk.STOCK_FILE)
submenu = Thunarx.Menu()
subitem1 = Thunarx.MenuItem(name='TMP::Subitem1',
label='Subitem1',
tooltip='First tip',
icon=Gtk.STOCK_DND)
subitem1.connect("activate", self.__subitem1_callback, window)
submenu.append_item(subitem1)
subitem2 = Thunarx.MenuItem(name='TMP::Subitem2',
label='Subitem2',
tooltip='Second tip',
icon=Gtk.STOCK_FULLSCREEN)
subitem2.connect("activate", self.__subitem2_callback, window)
submenu.append_item(subitem2)
item.set_menu(submenu)
item2 = Thunarx.MenuItem(name='TMP::Item2',
label='Another item',
tooltip='',
icon=Gtk.STOCK_OK)
return item,item2
def __subitem1_callback(self, item, window):
print("Subitem1 call")
def __subitem2_callback(self, item, window):
print("Subitem2 call")
</programlisting>
</example>
<!-- ****************************** -->
<!-- BEGIN OF METHODS -->
<!-- ****************************** -->
<refsect1>
<title>Passive Methods</title>
<refsect2 id="method-thunarx-python-menu-provider--get-file-menu-items">
<title>Thunarx.MenuProvider.get_file_menu_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_file_menu_items</methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">files</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">window</parameter> :</term>
<listitem><simpara>the current <link linkend="class-Gtkwindow"><classname>Gtk.Window</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">menu</parameter> :</term>
<listitem><simpara>a list of <link linkend="class-thunarx-python-file-info"><classname>Thunarx.FileInfo</classname></link> objects.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of Thunarx.MenuItem objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_file_menu_items</methodname>() method returns a list of
Thunarx.MenuItem objects.
</para>
</refsect2>
<refsect2 id="method-thunarx-python-menu-provider--get-folder-menu-items">
<title>Thunarx.MenuProvider.get_folder_menu_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_folder_menu_items</methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">folder</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">window</parameter> :</term>
<listitem><simpara>the current <link linkend="class-Gtkwindow"><classname>Gtk.Window</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">folder</parameter> :</term>
<listitem><simpara>the current folder, as a <link linkend="class-thunarx-python-file-info"><classname>Thunarx.FileInfo</classname></link> object.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of Thunarx.MenuItem objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_folder_menu_items</methodname>() method returns a list of
Thunarx.MenuItem objects.
</para>
</refsect2>
<refsect2 id="method-thunarx-python-menu-provider--get-dnd-menu-items">
<title>Thunarx.MenuProvider.get_dnd_menu_items</title>
<programlisting><methodsynopsis language="python">
<methodname>get_dnd_menu_items</methodname>
<methodparam><parameter role="keyword">window</parameter></methodparam>
<methodparam><parameter role="keyword">folder</parameter></methodparam>
<methodparam><parameter role="keyword">files</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">window</parameter> :</term>
<listitem><simpara>the current <link linkend="class-Gtkwindow"><classname>Gtk.Window</classname></link> instance</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">folder</parameter> :</term>
<listitem><simpara>the current folder, as a <link linkend="class-thunarx-python-file-info"><classname>Thunarx.FileInfo</classname></link> object.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">files</parameter> :</term>
<listitem><simpara>a list of the currently selected files, as a <link linkend="class-thunarx-python-file-info"><classname>Thunarx.FileInfo</classname></link> objects.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of Thunarx.MenuItem objects</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_dnd_menu_items</methodname>() method returns a list of
Thunarx.MenuItem objects.
</para>
</refsect2>
</refsect1>
</refentry>
|
