YMultiLineEdit Class Reference

Implementation of the MultiLineEdit widget. More...

#include <YMultiLineEdit.h>

Inheritance diagram for YMultiLineEdit:

List of all members.

Public Member Functions
	YMultiLineEdit (const YWidgetOpt &opt, const YCPString &label)
virtual char *	widgetClass ()
YCPValue	changeWidget (const YCPSymbol &property, const YCPValue &newvalue)
YCPValue	queryWidget (const YCPSymbol &property)
virtual void	setLabel (const YCPString &newLabel)
virtual void	setText (const YCPString &text)=0
virtual YCPString	text ()=0
YCPString	label () const
const char *	shortcutProperty ()
const char *	userInputProperty ()
virtual void	setInputMaxLength (const YCPInteger &numberOfChars)
Private Member Functions
virtual void	saveUserInput (YMacroRecorder *macroRecorder)
Private Attributes
YCPString	_label

---

Detailed Description

Implementation of the MultiLineEdit widget.

MultiLineEdit

• string label label above the field string initialText the initial contents of the field `MultiLineEdit( `id( `descr ), "Enter problem & description:", "No problem here." )

MultiLineEdit1.ycp MultiLineEdit2.ycp MultiLineEdit3.ycp MultiLineEdit-setInputMaxLength.ycp

This widget is a multiple line text entry field with a label above it. An initial text can be provided.

Note:

You can and should set a keyboard shortcut within the label. When the user presses the hotkey, the corresponding MultiLineEdit widget will get the keyboard focus.

---

Constructor & Destructor Documentation

YMultiLineEdit::YMultiLineEdit	(	const YWidgetOpt &	opt,
		const YCPString &	label
	)

Constructor.

---

Member Function Documentation

virtual char* YMultiLineEdit::widgetClass

(

)

[inline, virtual]

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

Reimplemented from YWidget.

YCPValue YMultiLineEdit::changeWidget	(	const YCPSymbol &	property,
		const YCPValue &	newvalue
	)			[virtual]

Implements the ui command changeWidget for the widget specific properties.

The text contents as one large string containing newlines.

Reimplemented from YWidget.

YCPValue YMultiLineEdit::queryWidget

(

const YCPSymbol &

property

)

[virtual]

Implements the ui command changeWidget for the widget specific properties.

Reimplemented from YWidget.

void YMultiLineEdit::setLabel

(

const YCPString &

newLabel

)

[virtual]

Set the label above the log lines. Overload this, but call YMultiLineEdit::setLabel at the end of your own function.

virtual void YMultiLineEdit::setText

(

const YCPString &

text

)

[pure virtual]

Set the edited text.

virtual YCPString YMultiLineEdit::text

(

)

[pure virtual]

Get the edited text.

YCPString YMultiLineEdit::label

(

)

const [inline]

Get the label above the log lines.

const char* YMultiLineEdit::shortcutProperty

(

)

[inline, virtual]

The name of the widget property that holds the keyboard shortcut. Inherited 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.

void YMultiLineEdit::setInputMaxLength

(

const YCPInteger &

numberOfChars

)

[virtual]

Specify the amount of characters which can be inserted.

Overload this to limit the input.

void YMultiLineEdit::saveUserInput

(

YMacroRecorder *

macroRecorder

)

[private, virtual]

Save the widget's user input to a macro recorder. Intentionally declared as "private" so all macro recording internals are handled by the abstract libyui level, not by a specific UI.

Reimplemented from YWidget.

---

Member Data Documentation

YCPString YMultiLineEdit::_label [private]

---

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

• YMultiLineEdit.h
• YMultiLineEdit.cc

---