libyui
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
YSimpleInputField Class Referenceabstract

#include <YSimpleInputField.h>

Inheritance diagram for YSimpleInputField:
Inheritance graph
[legend]
Collaboration diagram for YSimpleInputField:
Collaboration graph
[legend]

Public Member Functions

virtual ~YSimpleInputField ()
 
virtual std::string value ()=0
 
virtual void setValue (const std::string &text)=0
 
std::string label () const
 
virtual void setLabel (const std::string &label)
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySet & propertySet ()
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
const char * userInputProperty ()
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
virtual const char * widgetClass () const
 
virtual std::string debugLabel () const
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
bool hasChildren () const
 
YWidget * firstChild () const
 
YWidget * lastChild () const
 
YWidgetListIterator childrenBegin () const
 
YWidgetListIterator childrenEnd () const
 
YWidgetListConstIterator childrenConstBegin () const
 
YWidgetListConstIterator childrenConstEnd () const
 
YWidgetListIterator begin ()
 
YWidgetListIterator end ()
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidget * parent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialog * findDialog ()
 
YWidget * findWidget (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
 
YWidgetID * id () 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)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
void operator delete (void *ptr) noexcept
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YSimpleInputField (YWidget *parent, const std::string &label)
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManager * childrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

Abstract base class for simple input fields with a label above the field and a text value.

Constructor & Destructor Documentation

◆ YSimpleInputField()

YSimpleInputField::YSimpleInputField ( YWidget * parent,
const std::string & label )
protected

Constructor.

◆ ~YSimpleInputField()

YSimpleInputField::~YSimpleInputField ( )
virtual

Destructor.

Member Function Documentation

◆ getProperty()

YPropertyValue YSimpleInputField::getProperty ( const std::string & propertyName)
virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ label()

string YSimpleInputField::label ( ) const

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

◆ propertySet()

const YPropertySet & YSimpleInputField::propertySet ( )
virtual

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ setLabel()

void YSimpleInputField::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.

◆ setProperty()

bool YSimpleInputField::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.

◆ setShortcutString()

virtual void YSimpleInputField::setShortcutString ( const std::string & str)
inlinevirtual

Set the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ setValue()

virtual void YSimpleInputField::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.

◆ shortcutString()

virtual std::string YSimpleInputField::shortcutString ( ) const
inlinevirtual

Get the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

◆ userInputProperty()

const char * YSimpleInputField::userInputProperty ( )
inlinevirtual

The name of the widget property that will return user input. Inherited from YWidget.

Reimplemented from YWidget.

◆ value()

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

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