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
|
/* -*- c++ -*-
* Copyright (C)2000 Daniel M. Duley <[email protected]>
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#ifndef __KRECENTDOCUMENT_H
#define __KRECENTDOCUMENT_H
#include <tqstring.h>
#include <kurl.h>
/**
* Manage the "Recent Document Menu" entries displayed by
* applications such as Kicker and Konqueror.
*
* These entries are automatically generated .desktop files pointing
* to the current application and document. You should call the
* static add() method whenever the user opens or saves a new
* document if you want it to show up in the menu.
*
* You don't have to worry about this if you are using any
* KFileDialog derived class to open and save documents, as it
* already calls this class. User defined limits on the maximum
* number of documents to save, etc... are all automatically handled.
*
* @author Daniel M. Duley <[email protected]>
*/
class TDEIO_EXPORT KRecentDocument
{
public:
/**
*
* Return a list of absolute paths to recent document .desktop files,
* sorted by date.
*
*/
static TQStringList recentDocuments();
/**
* Add a new item to the Recent Document menu.
*
* @param url The url to add.
*/
static void add(const KURL& url);
/**
* Add a new item to the Recent Document menu, specifying the application to open it with.
* The above add() method uses argv[0] for the app name, which isn't always flexible enough.
* This method is used when an application launches another one to open a document.
*
* @param url The url to add.
* @param desktopEntryName The desktopEntryName of the service to use for opening this document.
*/
static void add(const KURL& url, const TQString& desktopEntryName);
/**
*
* Add a new item to the Recent Document menu. Calls add( url ).
*
* @param documentStr The full path to the document or URL to add.
* @param isURL Set to @p true if @p documentStr is an URL and not a local file path.
*/
static void add(const TQString &documentStr, bool isURL = false);
/**
* Clear the recent document menu of all entries.
*/
static void clear();
/**
* Returns the maximum amount of recent document entries allowed.
*/
static int maximumItems();
/**
* Returns the path to the directory where recent document .desktop files
* are stored.
*/
static TQString recentDocumentDirectory();
};
#endif
|
