DD::Image::SceneGraph_KnobI Class Reference

#include <SceneGraph_KnobI.h>

Public Member Functions
virtual void	addItems (const SceneItems &e, bool selected=false)=0
virtual void	setItems (const SceneItems &e, bool selected=false)=0
virtual void	removeItems (const std::vector< std::string > &e)=0
virtual void	clear ()=0
	remove all items in the view
virtual std::vector< std::string >	getItemNames () const =0
virtual SceneItems	getItems () const =0
virtual SceneItem	getItem (const std::string &path) const =0
	get a specific item by path
virtual void	setSelectedItems (const std::vector< std::string > &items)=0
	set the selected items
virtual std::vector< std::string >	getSelectedItems (const std::string &field=DD::Image::SceneGraph::kNameField) const =0
	get the selected items
virtual bool	hasSelection () const =0
	true if something is selected in the knob
virtual void	viewAllNodes (bool view)=0
virtual void	setColumnHeader (const std::string &title)=0
virtual void	enableListView ()=0
virtual void	setFocus ()=0
virtual bool	isEmpty () const =0

Detailed Description

Abstract base class for Scenegraph Knob-specific methods.

Member Function Documentation

addItems()

virtual void DD::Image::SceneGraph_KnobI::addItems ( const SceneItems &  e, bool  selected = false  )

pure virtual

augments the menu items on the knob with the given list.

Parameters

e	collection of scene graph items to insert into the tree

setItems()

virtual void DD::Image::SceneGraph_KnobI::setItems ( const SceneItems &  e, bool  selected = false  )

pure virtual

sets the items in the tree, removing any that no longer exist

Parameters

e	collection of scene graph items to insert into the tree
selected	set this to true to overwrite the value of already existing menu items

removeItems()

virtual void DD::Image::SceneGraph_KnobI::removeItems ( const std::vector< std::string > &  e )

pure virtual

removes from the knob all menu items contained in the given list. if you want this to persist you must use the SAVE_MENU flag on this knob.

getItemNames()

virtual std::vector< std::string > DD::Image::SceneGraph_KnobI::getItemNames ( ) const

pure virtual

get the menu items names set to the knob.

getItems()

virtual SceneItems DD::Image::SceneGraph_KnobI::getItems ( ) const

pure virtual

get the menu items set to the knob.

viewAllNodes()

virtual void DD::Image::SceneGraph_KnobI::viewAllNodes ( bool  view )

pure virtual

Toggle viewing filtered items

Parameters

view	true to unfilter items listed

setColumnHeader()

virtual void DD::Image::SceneGraph_KnobI::setColumnHeader ( const std::string &  title )

pure virtual

set the title of the nodelist column

enableListView()

virtual void DD::Image::SceneGraph_KnobI::enableListView ( )

pure virtual

set the view of the scene graph

setFocus()

virtual void DD::Image::SceneGraph_KnobI::setFocus ( )

pure virtual

set the focus to the scene graph knob so tab and knob are selected

isEmpty()

virtual bool DD::Image::SceneGraph_KnobI::isEmpty ( ) const

pure virtual

returns whether the given scenegraph is empty