summaryrefslogtreecommitdiffstats
path: root/kresources/selectdialog.h
diff options
context:
space:
mode:
Diffstat (limited to 'kresources/selectdialog.h')
-rw-r--r--kresources/selectdialog.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/kresources/selectdialog.h b/kresources/selectdialog.h
new file mode 100644
index 000000000..5ec90fc58
--- /dev/null
+++ b/kresources/selectdialog.h
@@ -0,0 +1,87 @@
+/*
+ This file is part of libkresources.
+
+ Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>
+ Copyright (c) 2002 Jan-Pascal van Best <janpascal@vanbest.org>
+ Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KRESOURCES_SELECTDIALOG_H
+#define KRESOURCES_SELECTDIALOG_H
+
+#include <qobject.h>
+#include <qptrlist.h>
+#include <qmap.h>
+
+#include <kdialog.h>
+
+class KListBox;
+
+namespace KRES {
+
+class Resource;
+
+/**
+ * Dialog for selecting a resource.
+ *
+ * Example:
+ *
+ * \code
+ *
+ * QPtrList<Resource> list = ... // can be retrived from KRES::Manager (e.g. KABC::AddressBook)
+ *
+ * KABC::Resource *res = KABC::SelectDialog::getResource( list, parentWdg );
+ * if ( !res ) {
+ * // no resource selected
+ * } else {
+ * // do something with resource
+ * }
+ * \endcode
+ */
+class KRESOURCES_EXPORT SelectDialog : KDialog
+{
+ public:
+ /**
+ * Constructor.
+ * @param list The list of available resources
+ * @param parent The parent widget
+ * @param name The name of the dialog
+ */
+ SelectDialog( QPtrList<Resource> list, QWidget *parent = 0,
+ const char *name = 0);
+
+ /**
+ * Returns selected resource.
+ */
+ Resource *resource();
+
+ /**
+ * Opens a dialog showing the available resources and returns the resource the
+ * user has selected. Returns 0, if the dialog was canceled.
+ */
+ static Resource *getResource( QPtrList<Resource> list, QWidget *parent = 0 );
+
+ private:
+ KListBox *mResourceId;
+
+ QMap<int, Resource*> mResourceMap;
+};
+
+}
+
+#endif