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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en" xml:lang="en">
<head>
<title>KBookmarkOwner</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KBookmarkOwner Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Subclasses: <a href="../kio/KonqBookmarkOwner.html">KonqBookmarkOwner</a><br />
<h2>Detailed Description</h2>
<p>The KBookmarkMenu and KBookmarkBar classes gives the user
the ability to either edit bookmarks or add their own. In the
first case, the app may want to open the bookmark in a special way.
In the second case, the app <em>must</em> supply the name and the
URL for the bookmark.
</p>
<p>
This class gives the app this callback-like ability.
</p>
<p>
If your app does not give the user the ability to add bookmarks and
you don't mind using the default bookmark editor to edit your
bookmarks, then you don't need to overload this class at all.
Rather, just use something like:
</p>
<p>
<CODE>
bookmarks = new KBookmarkMenu( mgr, 0, menu, actioncollec )
</CODE>
</p>
<p>
If you wish to use your own editor or allow the user to add
bookmarks, you must overload this class.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#BookmarkOption">BookmarkOption</a> </td><td class="memItemRight" valign="bottom">{ ShowAddBookmark, ShowEditBookmark }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KBookmarkDialog.html">KBookmarkDialog</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#bookmarkDialog">bookmarkDialog</a> (self, <a href="../kio/KBookmarkManager.html">KBookmarkManager</a> mgr, QWidget parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[(QString,QString)] </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentBookmarkList">currentBookmarkList</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentTitle">currentTitle</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentUrl">currentUrl</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#enableOption">enableOption</a> (self, <a href="../kio/KBookmarkOwner.html#BookmarkOption">KBookmarkOwner.BookmarkOption</a> option)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openBookmark">openBookmark</a> (self, <a href="../kio/KBookmark.html">KBookmark</a> bm, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MouseButtons</a> mb, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::KeyboardModifiers</a> km)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openFolderinTabs">openFolderinTabs</a> (self, <a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> bm)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#supportsTabs">supportsTabs</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="bookmarkDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KBookmarkDialog.html">KBookmarkDialog</a> bookmarkDialog</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KBookmarkManager.html">KBookmarkManager</a> </td>
<td class="paramname"><em>mgr</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="currentBookmarkList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[(QString,QString)] currentBookmarkList</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a list of title, URL pairs of the open tabs.
The default returns an empty list.
</p></div></div><a class="anchor" name="currentTitle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString currentTitle</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This function is called whenever the user wants to add the
current page to the bookmarks list. The title will become the
"name" of the bookmark. You must overload this function if you
wish to give your users the ability to add bookmarks.
The default returns an empty string.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the title of the current page.
</dd></dl>
</p></div></div><a class="anchor" name="currentUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString currentUrl</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This function is called whenever the user wants to add the
current page to the bookmarks list. The URL will become the URL
of the bookmark. You must overload this function if you wish to
give your users the ability to add bookmarks.
The default returns an empty string.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the URL of the current page.
</dd></dl>
</p></div></div><a class="anchor" name="enableOption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool enableOption</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KBookmarkOwner.html#BookmarkOption">KBookmarkOwner.BookmarkOption</a> </td>
<td class="paramname"><em>option</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns true if <b>action</b> should be shown in the menu
The default is to show both a add and editBookmark Entry
//TODO ContextMenuAction? to disable the contextMenu?
Delete and Propeties to disable those in the
context menu?
</p></div></div><a class="anchor" name="openBookmark"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> openBookmark</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KBookmark.html">KBookmark</a> </td>
<td class="paramname"><em>bm</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::MouseButtons</a> </td>
<td class="paramname"><em>mb</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html">Qt::KeyboardModifiers</a> </td>
<td class="paramname"><em>km</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Called if a bookmark is selected. You need to override this.
</p></div></div><a class="anchor" name="openFolderinTabs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> openFolderinTabs</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KBookmarkGroup.html">KBookmarkGroup</a> </td>
<td class="paramname"><em>bm</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Called if the user wants to open every bookmark in this folder in a new tab.
The default implementation does nothing.
This is only called if supportsTabs() returns true
</p></div></div><a class="anchor" name="supportsTabs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool supportsTabs</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This function returns whether the owner supports tabs.
The default returns false.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="BookmarkOption"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">BookmarkOption</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ShowAddBookmark</em> </td><td><tr><td valign="top"><em>ShowEditBookmark</em> </td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
