YMultiLineEdit Class Reference

Inheritance diagram for YMultiLineEdit:

List of all members.

Public Member Functions
virtual	~YMultiLineEdit ()
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)
int	inputMaxLength () const
virtual void	setInputMaxLength (int numberOfChars)
int	defaultVisibleLines () const
virtual void	setDefaultVisibleLines (int newVisibleLines)
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 ()
Protected Member Functions
	YMultiLineEdit (YWidget *parent, const string &label)

---

Constructor & Destructor Documentation

YMultiLineEdit::YMultiLineEdit	(	YWidget *	parent,
		const string &	label
	)		[protected]

Constructor.

YMultiLineEdit::~YMultiLineEdit

(

)

[virtual]

Destructor.

---

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.

YPropertyValue YMultiLineEdit::getProperty

(

const string &

propertyName

)

[virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

int YMultiLineEdit::inputMaxLength

(

)

const

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

string YMultiLineEdit::label

(

)

const

Get the label (the caption above the MultiLineEdit).

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.

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().

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.

void YMultiLineEdit::setLabel

(

const 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.

bool YMultiLineEdit::setProperty	(	const 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.

virtual void YMultiLineEdit::setShortcutString

(

const string &

str

)

[inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

virtual void YMultiLineEdit::setValue

(

const 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 string YMultiLineEdit::shortcutString

(

)

const [inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

const char* YMultiLineEdit::userInputProperty

(

)

[inline, virtual]

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

Reimplemented from YWidget.

virtual 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 [inline, virtual]

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

Reimplemented from YWidget.

---

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

• /data/gitorious.org/libyui/libyui-master/src/YMultiLineEdit.h
• /data/gitorious.org/libyui/libyui-master/src/YMultiLineEdit.cc