Mantid
|
The most generic widgets for Property's that are only a simple string. More...
#include <TextPropertyWidget.h>
Public Member Functions | |
QWidget * | getMainWidget () override |
QString | getValue () const override |
void | setValueImpl (const QString &value) override |
Set the value into the GUI. More... | |
TextPropertyWidget (Mantid::Kernel::Property *prop, QWidget *parent=nullptr, QGridLayout *layout=nullptr, int row=-1) | |
Constructor. More... | |
~TextPropertyWidget () override | |
Destructor. More... | |
Public Member Functions inherited from MantidQt::API::PropertyWidget | |
void | addReplaceWSButton () |
Create and show the "Replace WS" button. More... | |
QGridLayout * | getGridLayout () |
int | getGridRow () |
virtual QWidget * | getMainWidget ()=0 |
Mantid::Kernel::Property * | getProperty () |
virtual QString | getValue () const =0 |
Return the value of the property given the GUI state. More... | |
bool | inGrid () const |
PropertyWidget (Mantid::Kernel::Property *prop, QWidget *parent=nullptr, QGridLayout *layout=nullptr, int row=-1) | |
Constructor. More... | |
void | setEnabled (bool val) |
Sets all widgets contained within to Enabled. More... | |
void | setError (const QString &error) |
Externally set an error string to display in the validator. More... | |
void | setPreviousValue (const QString &previousValue) |
Set this widget's previously-entered value. More... | |
void | setValue (const QString &value) |
Set the value of the property given into the GUI state. More... | |
void | setVisible (bool val) override |
Sets all widgets contained within to Visible. More... | |
~PropertyWidget () override | |
Destructor. More... | |
Protected Attributes | |
QLabel * | m_label |
Label (name of the property) More... | |
QLineEdit * | m_textbox |
The text box to edit. More... | |
Protected Attributes inherited from MantidQt::API::PropertyWidget | |
QString | m_doc |
Documentation string (tooltip) More... | |
QString | m_enteredValue |
Stored the last non-previously-entered value entered entered by the user. More... | |
QString | m_error |
Error message received when trying to set the value. More... | |
QGridLayout * | m_gridLayout |
Grid layout of the dialog to which we are adding widgets. More... | |
QMap< Info, ClickableLabel * > | m_icons |
Allow icon access by Info enum. More... | |
bool | m_isOutputWsProp |
Whether or not the property is an output workspace. More... | |
QWidget * | m_parent |
Parent widget to add sub-widgets to. More... | |
QString | m_previousValue |
Stores the previously entered value when this dialog was last open. More... | |
Mantid::Kernel::Property * | m_prop |
Property being looked at. This is NOT owned by the widget. More... | |
QPushButton * | m_replaceWSButton |
Button to "replace input workspace". More... | |
int | m_row |
If using the GridLayout, this is the row where the widget was inserted. More... | |
bool | m_useHistory |
History on/off flag. More... | |
QVector< QWidget * > | m_widgets |
All contained widgets. More... | |
Additional Inherited Members | |
Public Types inherited from MantidQt::API::PropertyWidget | |
enum | Info { INVALID , REPLACE , RESTORE } |
Public Slots inherited from MantidQt::API::PropertyWidget | |
void | replaceWSButtonClicked () |
Deal with the "replace workspace" button being clicked. More... | |
void | toggleUseHistory () |
Toggle whether or not to use the previously-entered value. More... | |
void | updateIconVisibility (const QString &error="") |
Update which icons should be shown. More... | |
void | userEditedProperty () |
To be called when a user edits a property, as opposed to one being set programmatically. More... | |
void | valueChangedSlot () |
Emits a signal that the value of the property was changed. More... | |
Signals inherited from MantidQt::API::PropertyWidget | |
void | replaceWorkspaceName (const QString &propName) |
Signal is emitted whenever someone clicks the replace WS button. More... | |
void | userChangedProperty () |
void | valueChanged (const QString &propName) |
Signal is emitted whenever the value (as entered by the user) in the GUI changes. More... | |
Static Public Member Functions inherited from MantidQt::API::PropertyWidget | |
static void | setFieldPlaceholderText (Mantid::Kernel::Property *prop, QLineEdit *field) |
Set the placeholder text of the given field based on the default value of the given property. More... | |
Static Protected Member Functions inherited from MantidQt::API::PropertyWidget | |
static void | setLabelFont (Mantid::Kernel::Property *prop, QWidget *label) |
Set the font of the given label based on the optional/required status of the given property. More... | |
The most generic widgets for Property's that are only a simple string.
Definition at line 22 of file TextPropertyWidget.h.
MantidQt::API::TextPropertyWidget::TextPropertyWidget | ( | Mantid::Kernel::Property * | prop, |
QWidget * | parent = nullptr , |
||
QGridLayout * | layout = nullptr , |
||
int | row = -1 |
||
) |
Constructor.
Definition at line 18 of file TextPropertyWidget.cpp.
References MantidQt::API::PropertyWidget::m_doc, MantidQt::API::PropertyWidget::m_gridLayout, m_label, MantidQt::API::PropertyWidget::m_parent, MantidQt::API::PropertyWidget::m_prop, MantidQt::API::PropertyWidget::m_row, m_textbox, MantidQt::API::PropertyWidget::m_widgets, Mantid::Kernel::Property::name(), MantidQt::API::PropertyWidget::setFieldPlaceholderText(), MantidQt::API::PropertyWidget::setLabelFont(), MantidQt::API::PropertyWidget::setValue(), MantidQt::API::PropertyWidget::userEditedProperty(), and Mantid::Kernel::Property::value().
|
overridedefault |
Destructor.
|
inlineoverridevirtual |
Implements MantidQt::API::PropertyWidget.
Definition at line 33 of file TextPropertyWidget.h.
|
overridevirtual |
Implements MantidQt::API::PropertyWidget.
Definition at line 53 of file TextPropertyWidget.cpp.
References m_textbox.
|
overridevirtual |
Set the value into the GUI.
value | :: string representation of the value |
Implements MantidQt::API::PropertyWidget.
Definition at line 59 of file TextPropertyWidget.cpp.
|
protected |
Label (name of the property)
Definition at line 37 of file TextPropertyWidget.h.
Referenced by TextPropertyWidget().
|
protected |
The text box to edit.
Definition at line 40 of file TextPropertyWidget.h.
Referenced by MantidQt::API::FilePropertyWidget::browseClicked(), getValue(), setValueImpl(), and TextPropertyWidget().