#include <YMultiSelectionBox.h>

Inheritance diagram for YMultiSelectionBox:

[legend]

Collaboration diagram for YMultiSelectionBox:

[legend]

Public Member Functions
virtual	~YMultiSelectionBox ()
virtual const char *	widgetClass () const
bool	shrinkable () const
virtual void	setShrinkable (bool shrinkable=true)
virtual bool	setProperty (const std::string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const std::string &propertyName)
virtual const YPropertySet &	propertySet ()
const char *	userInputProperty ()
virtual YItem *	currentItem ()=0
virtual void	setCurrentItem (YItem *item)=0
virtual void	saveUserInput (YMacroRecorder *macroRecorder)
Public Member Functions inherited from YSelectionWidget
virtual	~YSelectionWidget ()
std::string	label () const
virtual void	setLabel (const std::string &newLabel)
virtual void	addItem (YItem *item_disown)
void	addItem (const std::string &itemLabel, bool selected=false)
void	addItem (const std::string &itemLabel, const std::string &iconName, bool selected=false)
virtual void	addItems (const YItemCollection &itemCollection)
virtual void	deleteAllItems ()
void	setItems (const YItemCollection &itemCollection)
YItemIterator	itemsBegin ()
YItemConstIterator	itemsBegin () const
YItemIterator	itemsEnd ()
YItemConstIterator	itemsEnd () const
bool	hasItems () const
int	itemsCount () const
YItem *	itemAt (int index) const
YItem *	firstItem () const
virtual YItem *	selectedItem ()
virtual YItemCollection	selectedItems ()
bool	hasSelectedItem ()
virtual void	selectItem (YItem *item, bool selected=true)
virtual void	setItemStatus (YItem *item, int status)
virtual void	deselectAllItems ()
void	setIconBasePath (const std::string &basePath)
std::string	iconBasePath () const
std::string	iconFullPath (const std::string &iconName) const
std::string	iconFullPath (YItem *item) const
bool	itemsContain (YItem *item) const
YItem *	findItem (const std::string &itemLabel) const
void	dumpItems () const
bool	enforceSingleSelection () const
virtual void	shortcutChanged ()
virtual std::string	shortcutString () const
virtual void	setShortcutString (const std::string &str)
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
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)
void *	operator new (size_t size)
void	operator delete (void *ptr) noexcept
virtual void	startMultipleChanges ()
virtual void	doneMultipleChanges ()

Protected Member Functions
	YMultiSelectionBox (YWidget *parent, const std::string &label)
Protected Member Functions inherited from YSelectionWidget
	YSelectionWidget (YWidget *parent, const std::string &label, bool enforceSingleSelection, bool recursiveSelection=false)
void	setEnforceSingleSelection (bool on)
void	setEnforceInitialSelection (bool on)
bool	enforceInitialSelection () const
bool	recursiveSelection () const
YItem *	findSelectedItem (YItemConstIterator begin, YItemConstIterator end)
void	findSelectedItems (YItemCollection &selectedItems, YItemConstIterator begin, YItemConstIterator end)
void	deselectAllItems (YItemIterator begin, YItemIterator end)
YItem *	findItem (const std::string &wantedItemLabel, YItemConstIterator begin, YItemConstIterator end) const
bool	itemsContain (YItem *wantedItem, YItemConstIterator begin, YItemConstIterator end) const
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

A variant of YSelectionBox where more than one item can be selected.

Constructor & Destructor Documentation

◆ YMultiSelectionBox()

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

protected

Constructor.

◆ ~YMultiSelectionBox()

YMultiSelectionBox::~YMultiSelectionBox ( )

virtual

Destructor.

Member Function Documentation

◆ currentItem()

virtual YItem * YMultiSelectionBox::currentItem ( )

pure virtual

Return the the item that currently has the keyboard focus or 0 if no item currently has the keyboard focus.

Notice that for a MultiSelectionBox the current item is not necessarily selected, i.e., its check box may or may not be checked.

Derived classes are required to implement this function.

◆ getProperty()

YPropertyValue YMultiSelectionBox::getProperty ( const std::string & propertyName )

virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ propertySet()

const YPropertySet & YMultiSelectionBox::propertySet ( )

virtual

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

Reimplemented from YWidget.

◆ saveUserInput()

void YMultiSelectionBox::saveUserInput ( YMacroRecorder * macroRecorder )

virtual

Save the widget's user input to a macro recorder.

Reimplemented from YWidget because two properties need to be recorded.

Reimplemented from YWidget.

◆ setCurrentItem()

virtual void YMultiSelectionBox::setCurrentItem ( YItem * item )

pure virtual

Set the keyboard focus to the specified item. 0 means clear the keyboard focus.

Notice that for a MultiSelectionBox the current item is not necessarily selected, i.e., its check box may or may not be checked. Use selectItem() for that.

Also notice that selectItem() does not make that newly selected item the current item.

Derived classes are required to implement this function.

◆ setProperty()

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

◆ setShrinkable()

void YMultiSelectionBox::setShrinkable ( bool shrinkable = true )

virtual

Make this MultiSelectionBox very small. This will take effect only upon the next geometry management run.

Derived classes can overwrite this, but should call this base class function in the new function.

◆ shrinkable()

bool YMultiSelectionBox::shrinkable ( ) const

Return 'true' if this MultiSelectionBox should be very small.

◆ userInputProperty()

const char * YMultiSelectionBox::userInputProperty ( )

inlinevirtual

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

Reimplemented from YWidget.

◆ widgetClass()

virtual const char * YMultiSelectionBox::widgetClass ( ) const

inlinevirtual

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

Reimplemented from YSelectionWidget.

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

/builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui/src/YMultiSelectionBox.h
/builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui/src/YMultiSelectionBox.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YMultiSelectionBox()

◆ ~YMultiSelectionBox()

Member Function Documentation

◆ currentItem()

◆ getProperty()

◆ propertySet()

◆ saveUserInput()

◆ setCurrentItem()

◆ setProperty()

◆ setShrinkable()

◆ shrinkable()

◆ userInputProperty()

◆ widgetClass()