diff options
author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2013-01-27 01:04:16 -0600 |
---|---|---|
committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2013-01-27 01:04:16 -0600 |
commit | 5159cd2beb2e87806a5b54e9991b7895285c9d3e (patch) | |
tree | 9b70e8be47a390f8f4d56ead812ab0c9dad88709 /tdeio/tdefile/krecentdocument.h | |
parent | c17cb900dcf52b8bd6dc300d4f103392900ec2b4 (diff) | |
download | tdelibs-5159cd2beb2e87806a5b54e9991b7895285c9d3e.tar.gz tdelibs-5159cd2beb2e87806a5b54e9991b7895285c9d3e.zip |
Rename a number of libraries and executables to avoid conflicts with KDE4
Diffstat (limited to 'tdeio/tdefile/krecentdocument.h')
-rw-r--r-- | tdeio/tdefile/krecentdocument.h | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/tdeio/tdefile/krecentdocument.h b/tdeio/tdefile/krecentdocument.h new file mode 100644 index 000000000..968559968 --- /dev/null +++ b/tdeio/tdefile/krecentdocument.h @@ -0,0 +1,105 @@ +/* -*- c++ -*- + * Copyright (C)2000 Daniel M. Duley <mosfet@kde.org> + * + * 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 <mosfet@kde.org> + */ +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 |