libyui
|
#include <YInputField.h>
Public Member Functions | |
virtual | ~YInputField () |
virtual const char * | widgetClass () const |
virtual string | value ()=0 |
virtual void | setValue (const string &text)=0 |
string | label () const |
virtual void | setLabel (const string &label) |
bool | passwordMode () const |
string | validChars () |
virtual void | setValidChars (const string &validChars) |
int | inputMaxLength () const |
virtual void | setInputMaxLength (int numberOfChars) |
bool | shrinkable () const |
virtual void | setShrinkable (bool shrinkable=true) |
virtual bool | setProperty (const string &propertyName, const YPropertyValue &val) |
virtual YPropertyValue | getProperty (const string &propertyName) |
virtual const YPropertySet & | propertySet () |
virtual string | shortcutString () const |
virtual void | setShortcutString (const string &str) |
const char * | userInputProperty () |
virtual void | saveUserInput (YMacroRecorder *macroRecorder) |
Protected Member Functions | |
YInputField (YWidget *parent, const string &label, bool passwordMode=false) |
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).
YInputField::YInputField | ( | YWidget * | parent, |
const string & | label, | ||
bool | passwordMode = false |
||
) | [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.
YInputField::~YInputField | ( | ) | [virtual] |
Destructor.
YPropertyValue YInputField::getProperty | ( | const string & | propertyName | ) | [virtual] |
int YInputField::inputMaxLength | ( | ) | const |
The maximum input length, i.e., the maximum number of characters the user can enter. -1 means no limit.
string YInputField::label | ( | ) | const |
Get the label (the caption above the input field).
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.
const YPropertySet & YInputField::propertySet | ( | ) | [virtual] |
void YInputField::saveUserInput | ( | YMacroRecorder * | macroRecorder | ) | [virtual] |
void YInputField::setInputMaxLength | ( | int | numberOfChars | ) | [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.
void YInputField::setLabel | ( | const string & | label | ) | [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.
bool YInputField::setProperty | ( | const string & | propertyName, |
const YPropertyValue & | val | ||
) | [virtual] |
virtual void YInputField::setShortcutString | ( | const string & | str | ) | [inline, virtual] |
void YInputField::setShrinkable | ( | bool | shrinkable = true | ) | [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.
void YInputField::setValidChars | ( | const string & | validChars | ) | [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.
virtual void YInputField::setValue | ( | const string & | text | ) | [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.
virtual string YInputField::shortcutString | ( | ) | const [inline, virtual] |
bool YInputField::shrinkable | ( | ) | const |
Return 'true' if this InputField should be very small.
const char* YInputField::userInputProperty | ( | ) | [inline, virtual] |
string YInputField::validChars | ( | ) |
Get the valid input characters. No input validation is performed (i.e., the user can enter anything) if this is empty.
virtual string YInputField::value | ( | ) | [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.
const char * YInputField::widgetClass | ( | ) | const [virtual] |
Return a descriptive name of this widget class for logging, debugging etc.
Reimplemented from YWidget.