libyui  3.3.2
YIntField Class Referenceabstract

IntField: Input field for integer values. More...

#include <YIntField.h>

Inheritance diagram for YIntField:
Collaboration diagram for YIntField:

Public Member Functions

virtual ~YIntField ()
 Destructor.
 
virtual const char * widgetClass () const
 Return a descriptive name of this widget class for logging, debugging etc.
 
virtual int value ()=0
 Get the current value (the number entered by the user or set from the outside) of this IntField. More...
 
void setValue (int val)
 Set the current value (the number entered by the user or set from the outside) of this IntField. More...
 
int minValue () const
 Return the minimum value.
 
void setMinValue (int val)
 Set a new minimum value. More...
 
int maxValue () const
 Return the maximum value.
 
void setMaxValue (int val)
 Set a new maximum value. 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...
 
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 YPropertySetpropertySet ()
 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...
 
- Public Member Functions inherited from YWidget
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.
 
YWidgetfirstChild () const
 Returns the first child or 0 if there is none. More...
 
YWidgetlastChild () 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.
 
YWidgetparent () 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.
 
YDialogfindDialog ()
 Traverse up the widget hierarchy and find the dialog this widget belongs to. More...
 
YWidgetfindWidget (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.
 
YWidgetIDid () 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.
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 Recursively save the user input of all child widgets to a macro recorder: More...
 
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

 YIntField (YWidget *parent, const std::string &label, int minValue, int maxValue)
 Constructor. More...
 
virtual void setValueInternal (int val)=0
 Set the current value (the number entered by the user or set from the outside) of this IntField. More...
 
int enforceRange (int val) const
 Enforce 'val' to be between minValue and maxValue. More...
 
- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 Constructor.
 
YWidgetChildrenManagerchildrenManager () 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.
 

Detailed Description

IntField: Input field for integer values.

Enforces input range between a specified minimum and maximum value.

Definition at line 38 of file YIntField.h.

Constructor & Destructor Documentation

◆ YIntField()

YIntField::YIntField ( YWidget parent,
const std::string &  label,
int  minValue,
int  maxValue 
)
protected

Constructor.

Create an IntField with 'label' as the caption, and the specified minimum and maximum values.

Note that YWidgetFactory::createIntField() also has an 'initialValue' parameter that is not used here (because the current value is not stored in this base class, but in the derived class).

Definition at line 50 of file YIntField.cc.

Here is the call graph for this function:

Member Function Documentation

◆ enforceRange()

int YIntField::enforceRange ( int  val) const
protected

Enforce 'val' to be between minValue and maxValue.

Return a value that is in range. This does not change the internally stored value of this IntField in any way.

Definition at line 71 of file YIntField.cc.

Here is the call graph for this function:

◆ getProperty()

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

Get a property.

Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 181 of file YIntField.cc.

Here is the call graph for this function:

◆ propertySet()

const YPropertySet & YIntField::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 139 of file YIntField.cc.

Here is the call graph for this function:

◆ setLabel()

void YIntField::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 131 of file YIntField.cc.

Here is the call graph for this function:

◆ setMaxValue()

void YIntField::setMaxValue ( int  val)

Set a new maximum value.

If the current value is greater than that, it will be set to the new maximum.

Definition at line 111 of file YIntField.cc.

Here is the call graph for this function:

◆ setMinValue()

void YIntField::setMinValue ( int  val)

Set a new minimum value.

If the current value is less than that, it will be set to the new minimum.

Definition at line 91 of file YIntField.cc.

Here is the call graph for this function:

◆ setProperty()

bool YIntField::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 163 of file YIntField.cc.

Here is the call graph for this function:

◆ setShortcutString()

virtual void YIntField::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 179 of file YIntField.h.

Here is the call graph for this function:

◆ setValue()

void YIntField::setValue ( int  val)
inline

Set the current value (the number entered by the user or set from the outside) of this IntField.

This method enforces 'val to be between minValue and maxValue.

Definition at line 81 of file YIntField.h.

Here is the call graph for this function:

◆ setValueInternal()

virtual void YIntField::setValueInternal ( int  val)
protectedpure virtual

Set the current value (the number entered by the user or set from the outside) of this IntField.

'val' is guaranteed to be between minValue and maxValue; no further checks are required.

Derived classes are required to implement this method.

◆ shortcutString()

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

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 172 of file YIntField.h.

Here is the call graph for this function:

◆ userInputProperty()

const char* YIntField::userInputProperty ( )
inlinevirtual

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

Inherited from YWidget.

Reimplemented from YWidget.

Definition at line 186 of file YIntField.h.

◆ value()

virtual int YIntField::value ( )
pure virtual

Get the current value (the number entered by the user or set from the outside) of this IntField.

Derived classes are required to implement this.


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