libyui  2.42.5
 All Classes Functions Variables Enumerations Friends
YMultiLineEdit Class Referenceabstract
Inheritance diagram for YMultiLineEdit:
YWidget

Public Member Functions

virtual ~YMultiLineEdit ()
 
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)
 
int inputMaxLength () const
 
virtual void setInputMaxLength (int numberOfChars)
 
int defaultVisibleLines () const
 
virtual void setDefaultVisibleLines (int newVisibleLines)
 
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 ()
 
- 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)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Protected Member Functions

 YMultiLineEdit (YWidget *parent, const std::string &label)
 
- 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

Definition at line 33 of file YMultiLineEdit.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 52 of file YMultiLineEdit.cc.

YMultiLineEdit::~YMultiLineEdit ( )
virtual

Destructor.

Definition at line 63 of file YMultiLineEdit.cc.

Member Function Documentation

int YMultiLineEdit::defaultVisibleLines ( ) const

Return the number of input lines that are visible by default.

This is what the widget would like to get (which will be reflected by preferredHeight() ), not what it currently actually has due to layout constraints.

Definition at line 93 of file YMultiLineEdit.cc.

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

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 145 of file YMultiLineEdit.cc.

int YMultiLineEdit::inputMaxLength ( ) const

The maximum input length, i.e., the maximum number of characters the user can enter. -1 means no limit.

Definition at line 81 of file YMultiLineEdit.cc.

std::string YMultiLineEdit::label ( ) const

Get the label (the caption above the MultiLineEdit).

Definition at line 69 of file YMultiLineEdit.cc.

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

void YMultiLineEdit::setDefaultVisibleLines ( int  newVisibleLines)
virtual

Set the number of input lines that are visible by default.

This is what the widget would like to get (which will be reflected by preferredHeight() ), not what it currently actually has due to layout constraints.

Notice that since a MultiLineEdit is stretchable in both dimensions, it might get more or less screen space, depending on the layout. This value is only meaningful if there are no other layout constraints.

Changing this value will not trigger a re-layout.

Derived classes can overwrite this function (but should call this base class function in the new function implementation), but it will normally be sufficient to query defaultVisibleLines() in preferredHeight().

Definition at line 99 of file YMultiLineEdit.cc.

void YMultiLineEdit::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 87 of file YMultiLineEdit.cc.

void YMultiLineEdit::setLabel ( const std::string &  label)
virtual

Set the label (the caption above the MultiLineEdit).

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 75 of file YMultiLineEdit.cc.

bool YMultiLineEdit::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 128 of file YMultiLineEdit.cc.

virtual void YMultiLineEdit::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 166 of file YMultiLineEdit.h.

virtual void YMultiLineEdit::setValue ( const std::string &  text)
pure virtual

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

Derived classes are required to implement this.

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

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 159 of file YMultiLineEdit.h.

const char* YMultiLineEdit::userInputProperty ( )
inlinevirtual

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

Reimplemented from YWidget.

Definition at line 173 of file YMultiLineEdit.h.

virtual std::string YMultiLineEdit::value ( )
pure virtual

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

Derived classes are required to implement this.

virtual const char* YMultiLineEdit::widgetClass ( ) const
inlinevirtual

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.

Definition at line 51 of file YMultiLineEdit.h.


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