libyui  2.42.5
 All Classes Functions Variables Enumerations Friends
YInputField Class Referenceabstract

#include <YInputField.h>

Inheritance diagram for YInputField:
YWidget

Public Member Functions

virtual ~YInputField ()
 
virtual const char * widgetClass () const
 
virtual std::string value ()=0
 
virtual void setValue (const std::string &text)=0
 
std::string label () const
 
virtual void setLabel (const std::string &label)
 
bool passwordMode () const
 
std::string validChars ()
 
virtual void setValidChars (const std::string &validChars)
 
int inputMaxLength () const
 
virtual void setInputMaxLength (int numberOfChars)
 
bool shrinkable () const
 
virtual void setShrinkable (bool shrinkable=true)
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
const char * userInputProperty ()
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
virtual std::string debugLabel () const
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
bool hasChildren () const
 
YWidgetfirstChild () const
 
YWidgetlastChild () const
 
YWidgetListConstIterator childrenBegin () const
 
YWidgetListConstIterator childrenEnd () const
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 
virtual int preferredWidth ()=0
 
virtual int preferredHeight ()=0
 
virtual int preferredSize (YUIDimension dim)
 
virtual void setSize (int newWidth, int newHeight)=0
 
bool isValid () const
 
bool beingDestroyed () const
 
void * widgetRep () const
 
void setWidgetRep (void *toolkitWidgetRep)
 
bool hasId () const
 
YWidgetIDid () const
 
void setId (YWidgetID *newId_disown)
 
virtual void setEnabled (bool enabled=true)
 
void setDisabled ()
 
virtual bool isEnabled () const
 
virtual bool stretchable (YUIDimension dim) const
 
void setStretchable (YUIDimension dim, bool newStretch)
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 
virtual int weight (YUIDimension dim)
 
bool hasWeight (YUIDimension dim)
 
void setWeight (YUIDimension dim, int weight)
 
void setNotify (bool notify=true)
 
bool notify () const
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 
bool notifyContextMenu () const
 
bool sendKeyEvents () const
 
void setSendKeyEvents (bool doSend)
 
bool autoShortcut () const
 
void setAutoShortcut (bool _newAutoShortcut)
 
int functionKey () const
 
bool hasFunctionKey () const
 
virtual void setFunctionKey (int fkey_no)
 
virtual bool setKeyboardFocus ()
 
void dumpWidgetTree (int indentationLevel=0)
 
void dumpDialogWidgetTree ()
 
void setChildrenEnabled (bool enabled)
 
void * operator new (size_t size)
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YInputField (YWidget *parent, const std::string &label, bool passwordMode=false)
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

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.

Constructor & Destructor Documentation

YInputField::YInputField ( YWidget parent,
const std::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.

Definition at line 53 of file YInputField.cc.

YInputField::~YInputField ( )
virtual

Destructor.

Definition at line 64 of file YInputField.cc.

Member Function Documentation

YPropertyValue YInputField::getProperty ( const std::string &  propertyName)
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.

std::string YInputField::label ( ) const

Get the label (the caption above the input field).

Definition at line 70 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.

const YPropertySet & YInputField::propertySet ( )
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.

void YInputField::saveUserInput ( YMacroRecorder macroRecorder)
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.

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.

Definition at line 119 of file YInputField.cc.

void YInputField::setLabel ( const std::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.

Definition at line 76 of file YInputField.cc.

bool YInputField::setProperty ( const std::string &  propertyName,
const YPropertyValue val 
)
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.

virtual void YInputField::setShortcutString ( const std::string &  str)
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.

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.

Definition at line 94 of file YInputField.cc.

void YInputField::setValidChars ( const std::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.

Definition at line 107 of file YInputField.cc.

virtual void YInputField::setValue ( const std::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 std::string YInputField::shortcutString ( ) const
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.

bool YInputField::shrinkable ( ) const

Return 'true' if this InputField should be very small.

Definition at line 88 of file YInputField.cc.

const char* YInputField::userInputProperty ( )
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.

virtual std::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.

Definition at line 194 of file YInputField.cc.


The documentation for this class was generated from the following files: