AoiToolBar Class Reference

Provides a user interface to edit the selected pixels in an AOI layer. More...

#include <AoiToolBar.h>

Inheritance diagram for AoiToolBar:

List of all members.

Public Member Functions

virtual void setSelectionTool (GraphicObjectType toolType, ModeType modeType)=0

virtual GraphicObjectType getSelectionTool () const =0

virtual ModeType getSelectionMode () const =0

virtual void setAddMode (AoiAddMode mode)=0

virtual AoiAddMode getAddMode () const =0

Static Public Member Functions

static GraphicObjectType getSettingSelectionTool ()

static bool hasSettingSelectionTool ()

static void setSettingSelectionTool (GraphicObjectType newValue, bool setIfSame=false)

static std::string getSettingSelectionToolKey ()

Protected Member Functions

virtual ~AoiToolBar ()

Detailed Description

Provides a user interface to edit the selected pixels in an AOI layer.

The AOI toolbar is a toolbar that allows users to edit the active AOI layer in the active view. This class provides the capability to set the pixel selection tools and to modify the way in which new pixels are added to the AOI layer.

A pointer to the AOI toolbar can be obtained by calling DesktopServices::getWindow() using "AOI" as the window name and TOOLBAR as the window type.

This subclass of Subject will notify upon the following conditions:

The toolbar is deleted, which will only occur on application shutdown.
Other notifications documented in the ToolBar class.

See also:: ToolBar, AoiLayer

Definition at line 35 of file AoiToolBar.h.

Constructor & Destructor Documentation

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

This toolbar will be destroyed automatically when the application closes.

Plug-ins do not need to destroy it.

Definition at line 134 of file AoiToolBar.h.

Member Function Documentation

static GraphicObjectType AoiToolBar::getSettingSelectionTool ( ) [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:: the current value for this setting.

Definition at line 48 of file AoiToolBar.h.

static bool AoiToolBar::hasSettingSelectionTool ( ) [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:: true if this setting exists, false otherwise.

Definition at line 55 of file AoiToolBar.h.

static void AoiToolBar::setSettingSelectionTool	(	GraphicObjectType	newValue,
		bool	setIfSame = `false`
	)			`[static]`

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:

	newValue	the new value for this setting.
	setIfSame	If `true`, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If `false`, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 71 of file AoiToolBar.h.

static std::string AoiToolBar::getSettingSelectionToolKey ( ) [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:: the key used for this setting.

Definition at line 79 of file AoiToolBar.h.

virtual void AoiToolBar::setSelectionTool	(	GraphicObjectType	toolType,
		ModeType	modeType
	)			`[pure virtual]`

Sets the current AOI pixel selection tool on the toolbar.

This method sets the current object that is created when the user adds a new object to an AOI layer and the drawing mode that is used when the user edits the layer with the mouse. The given object type and drawing mode are set into the current AOI layer of the current view and into each AOI layer that is activated in any view. To set the graphic object type and drawing mode in the layer separately from the AOI toolbar, call GraphicLayer::setCurrentGraphicObjectType() or AoiLayer::setMode() instead.

Parameters:

	toolType	The new pixel selection tool.
	modeType	The new pixel selection mode.

virtual GraphicObjectType AoiToolBar::getSelectionTool ( ) const [pure virtual]

Returns the current AOI pixel selection tool on the toolbar.

Returns:: The current pixel selection tool.

virtual ModeType AoiToolBar::getSelectionMode ( ) const [pure virtual]

Returns the current AOI pixel selection mode on the toolbar.

Returns:: The current pixel selection mode.

virtual void AoiToolBar::setAddMode ( AoiAddMode mode ) [pure virtual]

Sets the current AOI add mode on the toolbar.

Parameters:

mode

The new add mode.

virtual AoiAddMode AoiToolBar::getAddMode ( ) const [pure virtual]

Returns the current AOI add mode on the toolbar.

Returns:: The current add mode.


Public Member Functions
virtual void	setSelectionTool (GraphicObjectType toolType, ModeType modeType)=0
virtual GraphicObjectType	getSelectionTool () const =0
virtual ModeType	getSelectionMode () const =0
virtual void	setAddMode (AoiAddMode mode)=0
virtual AoiAddMode	getAddMode () const =0
Static Public Member Functions
static GraphicObjectType	getSettingSelectionTool ()
static bool	hasSettingSelectionTool ()
static void	setSettingSelectionTool (GraphicObjectType newValue, bool setIfSame=false)
static std::string	getSettingSelectionToolKey ()
Protected Member Functions
virtual	~AoiToolBar ()