diff options
Diffstat (limited to 'kolf/kcomboboxdialog.h')
| -rw-r--r-- | kolf/kcomboboxdialog.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/kolf/kcomboboxdialog.h b/kolf/kcomboboxdialog.h new file mode 100644 index 00000000..e835c0aa --- /dev/null +++ b/kolf/kcomboboxdialog.h @@ -0,0 +1,114 @@ +// Copyright (C) 2002 Jason Katz-Brown <[email protected]> +// Copyright (C) 2002 Neil Stevens <[email protected]> +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN +// AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +// +// Except as contained in this notice, the name(s) of the author(s) shall not be +// used in advertising or otherwise to promote the sale, use or other dealings +// in this Software without prior written authorization from the author(s). + +#ifndef KCOMBOBOX_DIALOG_H +#define KCOMBOBOX_DIALOG_H + +#include <qstringlist.h> + +#include <kdialogbase.h> +#include <kglobal.h> + +class QCheckBox; +class KHistoryCombo; + +/** + * Dialog for user to choose an item from a QStringList. + */ + +class KComboBoxDialog : public KDialogBase +{ +Q_OBJECT + +public: + /** + * Create a dialog that asks for a single line of text. _value is + * the initial value of the line. _text appears as the current text + * of the combobox. + * + * @param _items Items in the combobox + * @param _text Text of the label + * @param _value Initial value of the combobox + */ + KComboBoxDialog( const QString &_text, const QStringList& _items, const QString& _value = QString::null, bool showDontAskAgain = false, QWidget *parent = 0 ); + virtual ~KComboBoxDialog(); + + /** + * @return the value the user chose + */ + QString text() const; + + /** + * @return the line edit widget + */ + KHistoryCombo *comboBox() const { return combo; } + + /** + * Static convenience function to get input from the user. + * + * @param _text Text of the label + * @param _items Items in the combobox + * @param _value Initial value of the inputline + * @param dontAskAgainName Name for saving whether the user doesn't want to be asked again; use QString::null to disable + */ + static QString getItem( const QString &_text, const QStringList &_items, const QString& _value = QString::null, const QString &dontAskAgainName = QString::null, QWidget *parent = 0 ); + + /** + * Static convenience function to get input from the user. + * This method includes a caption. + * + * @param _caption Caption of the dialog + * @param _text Text of the label + * @param _items Items in the combobox + * @param _value Initial value of the inputline + * @param dontAskAgainName Name for saving whether the user doesn't want to be asked again; use QString::null to disable + */ + static QString getItem( const QString &_text, const QString &_caption, const QStringList &_items, const QString& _value = QString::null, const QString &dontAskAgainName = QString::null, QWidget *parent = 0 ); + + /** + * Static convenience method. + * This method is meant as a replacement for KLineEditDlg::getText() for cases + * when a history and autocompletion are desired. + * + * @param _caption Caption of the dialog + * @param _text Text of the label + * @param _value Initial value of the inputline + * @param ok Variable to store whether the user hit OK + * @param parent Parent widget for the dialog + * @param configName Name of the dialog for saving the completion and history + * @parma config KConfig for saving the completion and history + */ + static QString getText(const QString &_caption, const QString &_text, + const QString &_value = QString::null, + bool *ok = 0, QWidget *parent = 0, + const QString &configName = QString::null, + KConfig *config = KGlobal::config()); + +protected: + KHistoryCombo *combo; + QCheckBox *dontAskAgainCheckBox; + bool dontAskAgainChecked(); +}; + +#endif |