DD::Image::Enumeration_KnobI Class Reference

#include <Enumeration_KnobI.h>

Inheritance diagram for DD::Image::Enumeration_KnobI:

Public Member Functions
virtual void	menu (const std::vector< std::string > &e)=0
virtual const std::vector< std::string > &	menu () const =0
virtual int	getSelectedItemIndex () const =0
virtual std::string	getSelectedItemString () const =0
virtual std::string	getItemValueString (int itemIndex) const =0
virtual const char *	getError () const

Detailed Description

Abstract base class for Enumeration Knob-specific methods.

Member Function Documentation

menu() [1/2]

virtual void DD::Image::Enumeration_KnobI::menu ( const std::vector< std::string > &  e )

pure virtual

set the menu items on the knob to the given list. if you want this to persist you must use the SAVE_MENU flag on this knob.

menu() [2/2]

virtual const std::vector< std::string > & DD::Image::Enumeration_KnobI::menu ( ) const

pure virtual

get the list of menu items on the knob

getSelectedItemIndex()

virtual int DD::Image::Enumeration_KnobI::getSelectedItemIndex ( ) const

pure virtual

get the index of the currently selected item

getSelectedItemString()

virtual std::string DD::Image::Enumeration_KnobI::getSelectedItemString ( ) const

pure virtual

get the currently selected menu item

getItemValueString()

virtual std::string DD::Image::Enumeration_KnobI::getItemValueString ( int  itemIndex ) const

pure virtual

The selected menu item can contain tab-separated content to signify a different display string to the internal menu item option. This will return the internal menu item option only.

getError()

virtual const char * DD::Image::Enumeration_KnobI::getError ( ) const

inlinevirtual

The following function can be used to check the error state on Enumeration knobs. If we have the EXACT_MATCH_ONLY flag set, any attempt to set an enumeration knob by name to an invalid value will result in the knob being in an Error state. This function can be used to get the error value (i.e. the value that was attempted to set. Returns NULL if no error.

Referenced by DD::Image::Read::_validate(), and DD::Image::Write::_validate().