SettableSessionItem Class Reference

Provides access to set attribute values of a session item. More...

#include <SettableSessionItem.h>

Inheritance diagram for SettableSessionItem:

Inheritance graph

List of all members.

Public Member Functions

virtual bool setId (const SessionItemId &id)=0
virtual void setIcon (const QIcon &icon)=0
virtual void setName (const std::string &name)=0
virtual void setDisplayName (const std::string &displayName)=0
virtual void setDisplayText (const std::string &displayText)=0
virtual void addContextMenuAction (const ContextMenuAction &menuAction)=0
virtual void setContextMenuActions (const std::list< ContextMenuAction > &actions)=0
virtual void setFilenameDisplay (bool bFilenameDisplay)=0
virtual void addPropertiesPage (const std::string &plugInName)=0
virtual void removePropertiesPage (const std::string &plugInName)=0
virtual void setPropertiesPages (const std::vector< std::string > &plugInNames)=0
virtual void setValidSessionSaveItem (bool isValid)=0

Protected Member Functions

virtual ~SettableSessionItem ()

Detailed Description

Provides access to set attribute values of a session item.

This class provides a generic session item where the various attribute values can be set. Calling ObjectFactory::createObject("SettableSessionItem") creates an instance of this class.

SettableSessionItem is used internally and is typically not used by plug-in developers.

See also:
SessionItem

Definition at line 29 of file SettableSessionItem.h.

Constructor & Destructor Documentation

virtual SettableSessionItem::~SettableSessionItem (  )  [protected, virtual]

This object should be destroyed by calling ObjectFactory::destroyObject().

Definition at line 207 of file SettableSessionItem.h.

Member Function Documentation

virtual bool SettableSessionItem::setId ( const SessionItemId &  id  )  [pure virtual]

Sets the id of the session item.

This method will set the id of the item. It will only work if getId has not yet been called.

Parameters:
id The new id for the SessionItem.
Returns:
Returns true if the id was successfully set, or false otherwise.

virtual void SettableSessionItem::setIcon ( const QIcon &  icon  )  [pure virtual]

Associates an icon with the session item.

The icon can be used by widgets displaying the session item to differentiate between mutliple session item types, or to uniquely identify this session item.

Parameters:
icon The icon to associate with the session item.

virtual void SettableSessionItem::setName ( const std::string &  name  )  [pure virtual]

Sets the full session item name.

Parameters:
name The session item name.
See also:
setDisplayName()

virtual void SettableSessionItem::setDisplayName ( const std::string &  displayName  )  [pure virtual]

Sets the session item name that should be displayed to the user.

The display name can optionally be used to present a shorter name to the user. If the display name is not set, the full session item name may be displayed to the user instead.

Parameters:
displayName The name that should be displayed to the user for this session item.
See also:
setName()

virtual void SettableSessionItem::setDisplayText ( const std::string &  displayText  )  [pure virtual]

Sets additional text about the session item to be displayed to the user.

The display text is an optional means by which additional information about this session item can be displayed to the user.

Parameters:
displayText The text string containing additional information about this session item to display to the user.

virtual void SettableSessionItem::addContextMenuAction ( const ContextMenuAction &  menuAction  )  [pure virtual]

Adds a single context menu action to the list of available actions for this session item.

This method adds an action to the list of available actions that are avaiable when the user right-clicks on a widget that displays or contains the session item. This method is typically called with an action that should be available regardless of the current state of the session or the item.

Parameters:
menuAction A context menu action that should be displayed when the user right-clicks on a widget that displays or contains the session item.
See also:
setContextMenuActions()

virtual void SettableSessionItem::setContextMenuActions ( const std::list< ContextMenuAction > &  actions  )  [pure virtual]

Sets available context menu actions for this session item.

This method sets actions that are available to the user when right-clicking on a widget that displays or contains the session item. This method is typically called with actions that should be available regardless of the current state of the session or the item.

Parameters:
actions A list of context menu actions that should be displayed when the user right-clicks on a widget that displays or contains the session item.
See also:
addContextMenuAction()

virtual void SettableSessionItem::setFilenameDisplay ( bool  bFilenameDisplay  )  [pure virtual]

Sets whether the display name and display text are automatically updated when a filename is set as the item name.

Parameters:
bFilenameDisplay If this parameter is true, the display name and display text will automatically be updated when setName() is called with a filename. If this parameter is false, the display name and display text are not affected when setName() is called.
See also:
hasFilenameDisplay()

virtual void SettableSessionItem::addPropertiesPage ( const std::string &  plugInName  )  [pure virtual]

Adds a Properties plug-in name to the vector of available properties pages for this session item.

This method adds the name of a single Properties plug-in to the vector of available properties plug-ins whose widgets are displayed to the user in the properties dialog for this session item.

Parameters:
plugInName The Properties plug-in name to add to the vector of pages that should be displayed in the properties dialog for this session item.
See also:
setPropertiesPages()

virtual void SettableSessionItem::removePropertiesPage ( const std::string &  plugInName  )  [pure virtual]

Removes a Properties plug-in name from the vector of available properties pages for this session item.

This method removed the name of a single Properties plug-in from the vector of available properties plug-ins whose widgets are displayed to the user in the properties dialog for this session item.

Parameters:
plugInName The Properties plug-in name to remove from the vector of pages that should be displayed in the properties dialog for this session item.
See also:
addPropertiesPage()

virtual void SettableSessionItem::setPropertiesPages ( const std::vector< std::string > &  plugInNames  )  [pure virtual]

Sets the available properties pages for this session item.

This method sets the names of all Properties plug-ins whose widgets are displayed to the user in the properties dialog for this session item.

Parameters:
plugInNames A vector of Properties plug-in names whose widgets should be displayed in the properties dialog for this item.
See also:
addPropertiesPage()

virtual void SettableSessionItem::setValidSessionSaveItem ( bool  isValid  )  [pure virtual]

Sets session save validity.

Method sets whether or not the item will be included when saving a session.

Parameters:
isValid Session save validity of the item.

Software Development Kit - Opticks 4.9.0 Build 16218