libyui
3.3.1
|
InputField: General purpose one line input field for entering text and other data. More...
#include <YInputField.h>
Public Member Functions | |
virtual | ~YInputField () |
Destructor. | |
virtual const char * | widgetClass () const |
Return a descriptive name of this widget class for logging, debugging etc. | |
virtual std::string | value ()=0 |
Get the current value (the text entered by the user or set from the outside) of this input field. More... | |
virtual void | setValue (const std::string &text)=0 |
Set the current value (the text entered by the user or set from the outside) of this input field. More... | |
std::string | label () const |
Get the label (the caption above the input field). | |
virtual void | setLabel (const std::string &label) |
Set the label (the caption above the input field). More... | |
bool | passwordMode () const |
Returns 'true' if this input field is in password mode, i.e. More... | |
std::string | validChars () |
Get the valid input characters. More... | |
virtual void | setValidChars (const std::string &validChars) |
Set the valid input characters. More... | |
int | inputMaxLength () const |
The maximum input length, i.e., the maximum number of characters the user can enter. More... | |
virtual void | setInputMaxLength (int numberOfChars) |
Set the maximum input length, i.e., the maximum number of characters the user can enter. More... | |
bool | shrinkable () const |
Return 'true' if this InputField should be very small. | |
virtual void | setShrinkable (bool shrinkable=true) |
Make this InputField very small. More... | |
virtual bool | setProperty (const std::string &propertyName, const YPropertyValue &val) |
Set a property. More... | |
virtual YPropertyValue | getProperty (const std::string &propertyName) |
Get a property. More... | |
virtual const YPropertySet & | propertySet () |
Return this class's property set. More... | |
virtual std::string | shortcutString () const |
Get the string of this widget that holds the keyboard shortcut. More... | |
virtual void | setShortcutString (const std::string &str) |
Set the string of this widget that holds the keyboard shortcut. More... | |
const char * | userInputProperty () |
The name of the widget property that will return user input. More... | |
virtual void | saveUserInput (YMacroRecorder *macroRecorder) |
Save the widget's user input to a macro recorder. More... | |
![]() | |
virtual | ~YWidget () |
Destructor. | |
virtual std::string | debugLabel () const |
Returns a descriptive label of this widget instance. More... | |
std::string | helpText () const |
Return the help text for this widget. | |
void | setHelpText (const std::string &helpText) |
Set a help text for this widget. More... | |
bool | hasChildren () const |
Returns 'true' if this widget has any children. | |
YWidget * | firstChild () const |
Returns the first child or 0 if there is none. More... | |
YWidget * | lastChild () const |
Returns the last child or 0 if there is none. | |
YWidgetListIterator | childrenBegin () const |
Return an iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListIterator | childrenEnd () const |
Return an interator that points after the last child. | |
YWidgetListConstIterator | childrenConstBegin () const |
Return a const iterator that points to the first child or to childrenEnd() if there are no children. | |
YWidgetListConstIterator | childrenConstEnd () const |
Return a const interator that points after the last child. | |
YWidgetListIterator | begin () |
A helper for the range-based "for" loop. More... | |
YWidgetListIterator | end () |
A helper for the range-based "for" loop. More... | |
int | childrenCount () const |
Returns the current number of children. | |
bool | contains (YWidget *child) const |
Checks if 'child' is a (direct!) child of this widget. | |
virtual void | addChild (YWidget *child) |
Add a new child. More... | |
virtual void | removeChild (YWidget *child) |
Remove a child. More... | |
void | deleteChildren () |
Delete all children and remove them from the children manager's list. | |
YWidget * | parent () const |
Return this widget's parent or 0 if it doesn't have a parent. | |
bool | hasParent () const |
Return 'true' if this widget has a parent, 'false' if not. | |
void | setParent (YWidget *newParent) |
Set this widget's parent. | |
YDialog * | findDialog () |
Traverse up the widget hierarchy and find the dialog this widget belongs to. More... | |
YWidget * | findWidget (YWidgetID *id, bool doThrow=true) const |
Recursively find a widget by its ID. More... | |
virtual int | preferredWidth ()=0 |
Preferred width of the widget. More... | |
virtual int | preferredHeight ()=0 |
Preferred height of the widget. More... | |
virtual int | preferredSize (YUIDimension dim) |
Preferred size of the widget in the specified dimension. More... | |
virtual void | setSize (int newWidth, int newHeight)=0 |
Set the new size of the widget. More... | |
bool | isValid () const |
Checks whether or not this object is valid. More... | |
bool | beingDestroyed () const |
Check if this widget is in the process of being destroyed. | |
void * | widgetRep () const |
Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. | |
void | setWidgetRep (void *toolkitWidgetRep) |
Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More... | |
bool | hasId () const |
Returns 'true' if this widget has an ID. | |
YWidgetID * | id () const |
Returns this widget's ID. | |
void | setId (YWidgetID *newId_disown) |
Set this widget's ID. More... | |
virtual void | setEnabled (bool enabled=true) |
Enable or disable this widget, i.e. More... | |
void | setDisabled () |
Disable this widget (overloaded for better readability). | |
virtual bool | isEnabled () const |
Returns 'true' if this widget is enabled. | |
virtual bool | stretchable (YUIDimension dim) const |
This is a boolean value that determines whether the widget is resizable beyond its preferred size in the specified dimension. More... | |
void | setStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options. | |
void | setDefaultStretchable (YUIDimension dim, bool newStretch) |
Set the stretchable state to "newStretch". More... | |
virtual int | weight (YUIDimension dim) |
The weight is used in situations where all widgets can get their preferred size and yet space is available. More... | |
bool | hasWeight (YUIDimension dim) |
Return whether or not the widget has a weight in the specified dimension. | |
void | setWeight (YUIDimension dim, int weight) |
Set a weight in the specified dimension. | |
void | setNotify (bool notify=true) |
Sets the Notify property. | |
bool | notify () const |
Returns whether the widget will notify, i.e. More... | |
void | setNotifyContextMenu (bool notifyContextMenu=true) |
Sets the notifyContextMenu property. | |
bool | notifyContextMenu () const |
Returns whether the widget will send an event when the user clicks selects the context menu e.g. More... | |
bool | sendKeyEvents () const |
Returns 'true' if this widget should send key events, i.e. More... | |
void | setSendKeyEvents (bool doSend) |
Specify whether or not this widget should send key events. | |
bool | autoShortcut () const |
Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file. | |
void | setAutoShortcut (bool _newAutoShortcut) |
Sets the 'autoShortcut' flag. | |
int | functionKey () const |
Return a function key number that is assigned to this widget. More... | |
bool | hasFunctionKey () const |
Check if a function key is assigned to this widget. | |
virtual void | setFunctionKey (int fkey_no) |
Assign a function key to this widget (1 for F1, 2 for F2, etc. More... | |
virtual bool | setKeyboardFocus () |
Set the keyboard focus to this widget. More... | |
void | dumpWidgetTree (int indentationLevel=0) |
Debugging function: Dump the widget tree from here on to the log file. | |
void | dumpDialogWidgetTree () |
Debugging function: Dump the widget tree from this widget's dialog parent. More... | |
void | setChildrenEnabled (bool enabled) |
Enable or disable all widgets in this widget tree. | |
void * | operator new (size_t size) |
Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More... | |
virtual void | startMultipleChanges () |
In some UIs updating the screen content is an expensive operation. More... | |
virtual void | doneMultipleChanges () |
Protected Member Functions | |
YInputField (YWidget *parent, const std::string &label, bool passwordMode=false) | |
Constructor. More... | |
![]() | |
YWidget (YWidget *parent) | |
Constructor. | |
YWidgetChildrenManager * | childrenManager () const |
Returns this widget's children manager. | |
void | setChildrenManager (YWidgetChildrenManager *manager) |
Sets a new children manager for this widget. More... | |
void | setBeingDestroyed () |
Set the "being destroyed" flag, i.e. More... | |
void | dumpWidget (YWidget *w, int indentationLevel) |
Helper function for dumpWidgetTree(): Dump one widget to the log file. | |
InputField: General purpose one line input field for entering text and other data.
Can be used for entering passwords with a "*" echoed for every character typed.
Like most widgets, the InputField has a label (a caption) above the input field itself. The label can and should get a keyboard shortcut (specified with '&') that will make the input field receive the keyboard focus with a special key combination ("&Name" -> Alt-N or Ctrl-N will make the keyboard focus jump to the corresponding input field).
Definition at line 46 of file YInputField.h.
|
protected |
Constructor.
Create an input field with 'label' as the caption. If 'passwordMode' is set, the input will be not be echoed as clear text.
Definition at line 53 of file YInputField.cc.
|
virtual |
Get a property.
Reimplemented from YWidget.
This method may throw YUIPropertyExceptions.
Reimplemented from YWidget.
Definition at line 168 of file YInputField.cc.
int YInputField::inputMaxLength | ( | ) | const |
The maximum input length, i.e., the maximum number of characters the user can enter.
-1 means no limit.
Definition at line 113 of file YInputField.cc.
bool YInputField::passwordMode | ( | ) | const |
Returns 'true' if this input field is in password mode, i.e.
if there should be no on-screen echo or only a '*' for each character typed.
Notice that this can only be set in the constructor.
Definition at line 82 of file YInputField.cc.
|
virtual |
Return this class's property set.
This also initializes the property upon the first call.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 126 of file YInputField.cc.
|
virtual |
Save the widget's user input to a macro recorder.
Reimplemented from YWidget to avoid recording passwords.
Reimplemented from YWidget.
Definition at line 184 of file YInputField.cc.
|
virtual |
Set the maximum input length, i.e., the maximum number of characters the user can enter.
-1 means no limit.
Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.
Definition at line 119 of file YInputField.cc.
|
virtual |
Set the label (the caption above the input field).
Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.
Definition at line 76 of file YInputField.cc.
|
virtual |
Set a property.
Reimplemented from YWidget.
This function may throw YUIPropertyExceptions.
This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).
Reimplemented from YWidget.
Definition at line 150 of file YInputField.cc.
|
inlinevirtual |
Set the string of this widget that holds the keyboard shortcut.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 193 of file YInputField.h.
|
virtual |
Make this InputField very small.
This will take effect only upon the next geometry management run.
Derived classes can overwrite this, but should call this base class function in the new function.
Definition at line 94 of file YInputField.cc.
|
virtual |
Set the valid input characters.
No input validation is performed (i.e., the user can enter anything) if this is empty.
Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.
Definition at line 107 of file YInputField.cc.
|
pure virtual |
Set the current value (the text entered by the user or set from the outside) of this input field.
Derived classes are required to implement this.
|
inlinevirtual |
Get the string of this widget that holds the keyboard shortcut.
Reimplemented from YWidget.
Reimplemented from YWidget.
Definition at line 186 of file YInputField.h.
|
inlinevirtual |
The name of the widget property that will return user input.
Inherited from YWidget.
Reimplemented from YWidget.
Definition at line 200 of file YInputField.h.
std::string YInputField::validChars | ( | ) |
Get the valid input characters.
No input validation is performed (i.e., the user can enter anything) if this is empty.
Definition at line 101 of file YInputField.cc.
|
pure virtual |
Get the current value (the text entered by the user or set from the outside) of this input field.
Derived classes are required to implement this.