KDE 4.2 API Reference kalarm
PickFileRadio Class Reference
#include <pickfileradio.h>
Detailed Description
Radio button with associated file picker controls.The PickFileRadio class is a radio button with an associated button to choose a file, and an optional file name edit box. Its purpose is to ensure that while the radio button is selected, the chosen file name is never blank.
To achieve this, whenever the button is newly selected and the file name is currently blank, the file picker dialog is displayed to choose a file. If the dialog exits without a file being chosen, the radio button selection is reverted to the previously selected button in the parent button group.
The class handles the activation of the file picker dialog (via a virtual method which must be supplied by deriving a class from this one). It also handles all enabling and disabling of the browse button and edit box when the enable state of the radio button is changed, and when the radio button selection changes.
Definition at line 51 of file pickfileradio.h.
Public Slots | |
| virtual void | setEnabled (bool) |
Public Member Functions | |
| QString | file () const |
| LineEdit * | fileEdit () const |
| void | init (QPushButton *button, LineEdit *edit=0) |
| virtual QString | pickFile ()=0 |
| PickFileRadio (const QString &text, ButtonGroup *group, QWidget *parent) | |
| PickFileRadio (QPushButton *button, LineEdit *edit, const QString &text, ButtonGroup *group, QWidget *parent) | |
| QPushButton * | pushButton () const |
| void | setFile (const QString &file) |
| virtual void | setReadOnly (bool readOnly) |
Constructor & Destructor Documentation
| PickFileRadio::PickFileRadio | ( | QPushButton * | button, | |
| LineEdit * | edit, | |||
| const QString & | text, | |||
| ButtonGroup * | group, | |||
| QWidget * | parent | |||
| ) |
Constructor.
- Parameters:
-
button Push button to invoke the file picker dialog. edit File name edit widget, or null if there is none. text Radio button's text. parent Button group which is to be the parent object for the radio button.
Definition at line 33 of file pickfileradio.cpp.
| PickFileRadio::PickFileRadio | ( | const QString & | text, | |
| ButtonGroup * | group, | |||
| QWidget * | parent | |||
| ) |
Constructor.
The init() method must be called before the widget can be used.
- Parameters:
-
text Radio button's text. parent Button group which is to be the parent object for the radio button.
Definition at line 50 of file pickfileradio.cpp.
Member Function Documentation
| QString PickFileRadio::file | ( | ) | const |
| LineEdit* PickFileRadio::fileEdit | ( | ) | const [inline] |
Returns the associated file name edit widget, or null if none.
Definition at line 93 of file pickfileradio.h.
| void PickFileRadio::init | ( | QPushButton * | button, | |
| LineEdit * | edit = 0 | |||
| ) |
Initialises the widget.
- Parameters:
-
button Push button to invoke the file picker dialog. edit File name edit widget, or null if there is none.
Definition at line 61 of file pickfileradio.cpp.
| virtual QString PickFileRadio::pickFile | ( | ) | [pure virtual] |
Chooses a file, for example by displaying a file selection dialog.
This method is called when the push button is clicked - the client should not activate a file selection dialog directly.
- Returns:
- Selected file name, or QString() if no selection made.
| QPushButton* PickFileRadio::pushButton | ( | ) | const [inline] |
| void PickFileRadio::setEnabled | ( | bool | enable | ) | [virtual, slot] |
Enables or disables the radio button, and adjusts the enabled state of the associated browse button and file name edit box.
Definition at line 102 of file pickfileradio.cpp.
| void PickFileRadio::setFile | ( | const QString & | file | ) |
Notifies the widget of the currently selected file name.
This should only be used when no file name edit box is used. It should be called to initialise the widget's data, and also any time the file name is changed without using the push button.
Definition at line 88 of file pickfileradio.cpp.
| void PickFileRadio::setReadOnly | ( | bool | readOnly | ) | [virtual] |
Sets whether the radio button and associated widgets are read-only for the user.
If read-only, their states cannot be changed by the user.
- Parameters:
-
readOnly True to set the widgets read-only, false to set them read-write.
Reimplemented from RadioButton.
Definition at line 74 of file pickfileradio.cpp.
The documentation for this class was generated from the following files:
