Isis::MosaicTool Class Reference

Base class for the MosaicTools. More...

#include <MosaicTool.h>

Inheritance diagram for Isis::MosaicTool:

Collaboration diagram for Isis::MosaicTool:

Public Slots
void	activate (bool)
	Activates the tool. More...

Signals
void	activated (bool)

Public Member Functions
	MosaicTool (MosaicSceneWidget *)
bool	isActive () const
	Returns the activeness of this toool. More...
QPixmap	getIcon (QString iconName) const
	returns the path to the icon directory. More...
virtual void	addTo (QMenu *menu)
virtual void	addTo (ToolPad *toolPad)
virtual void	addTo (QToolBar *toolBar)
virtual QList< QAction * >	getViewActions ()
virtual PvlObject	toPvl () const
virtual void	fromPvl (const PvlObject &obj)
virtual QString	projectPvlObjectName () const

Protected Slots
virtual void	updateTool ()

Protected Member Functions
virtual void	mouseEnter ()
virtual void	mouseMove (QPointF)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPointF)
virtual void	mouseButtonPress (QPointF, Qt::MouseButton s)
virtual void	mouseButtonRelease (QPointF, Qt::MouseButton s)
virtual void	mouseWheel (QPointF, int delta)
virtual void	rubberBandComplete (QRectF r, Qt::MouseButton s)
void	toolBarDestroyed (QObject *obj)
MosaicSceneWidget *	getWidget ()
virtual QAction *	getPrimaryAction ()=0
	This method returns an action that is used to activate this tool. More...
virtual QWidget *	getToolBarWidget ()
	This method returns a widget that will be put in a tool bar when the tool is activated. More...

Private Member Functions
void	enableToolBar ()
	Enables entire tool bar. More...
void	disableToolBar ()
	Disables entire tool bar. More...

Private Attributes
bool	p_active
	Is the tool active? More...
MosaicSceneWidget *	p_widget
QAction *	p_primaryAction
QAction *	p_toolBarAction

Detailed Description

Base class for the MosaicTools.

Author

????-??-?? Stacy Alley

History:

2011-04-14 Steven Lambright Refactored to use the new MosaicSceneWidget

History:

2011-09-27 Steven Lambright - No longer produces errors when given a NULL MosaicSceneWidget.

History:

2011-11-04 Steven Lambright - Added getViewActions().

Definition at line 37 of file MosaicTool.h.

Member Function Documentation

activate

void Isis::MosaicTool::activate ( bool  on )

slot

Activates the tool.

Parameters

on

Definition at line 148 of file MosaicTool.cpp.

References disableToolBar(), enableToolBar(), and p_active.

disableToolBar()

void Isis::MosaicTool::disableToolBar ( )

private

Disables entire tool bar.

Definition at line 174 of file MosaicTool.cpp.

Referenced by activate().

enableToolBar()

void Isis::MosaicTool::enableToolBar ( )

private

Enables entire tool bar.

Definition at line 185 of file MosaicTool.cpp.

Referenced by activate().

getIcon()

QPixmap Isis::MosaicTool::getIcon

(

QString

iconName

)

const

returns the path to the icon directory.

Returns

QString

Definition at line 115 of file MosaicTool.cpp.

References Isis::FileName::expanded().

Referenced by Isis::MosaicAreaTool::getPrimaryAction(), Isis::MosaicControlNetTool::getPrimaryAction(), Isis::MosaicFindTool::getPrimaryAction(), Isis::MosaicGridTool::getPrimaryAction(), Isis::MosaicPanTool::getPrimaryAction(), Isis::MosaicSelectTool::getPrimaryAction(), Isis::MosaicZoomTool::getPrimaryAction(), and Isis::MosaicZoomTool::MosaicZoomTool().

getPrimaryAction()

virtual QAction* Isis::MosaicTool::getPrimaryAction ( )

protectedpure virtual

This method returns an action that is used to activate this tool.

This method will only be called once so it can new the action without a problem.

Implemented in Isis::MosaicZoomTool, Isis::MosaicTrackTool, Isis::MosaicSelectTool, Isis::MosaicPanTool, Isis::MosaicGridTool, Isis::MosaicFindTool, Isis::MosaicControlNetTool, and Isis::MosaicAreaTool.

getToolBarWidget()

QWidget * Isis::MosaicTool::getToolBarWidget ( )

protectedvirtual

This method returns a widget that will be put in a tool bar when the tool is activated.

This method will only be called once so it can new the widget without a problem.

Reimplemented in Isis::MosaicZoomTool, Isis::MosaicGridTool, Isis::MosaicFindTool, Isis::MosaicControlNetTool, and Isis::MosaicAreaTool.

Definition at line 192 of file MosaicTool.cpp.

isActive()

bool Isis::MosaicTool::isActive ( ) const

inline

Returns the activeness of this toool.

Returns

bool

Definition at line 50 of file MosaicTool.h.

References p_active.

Referenced by Isis::MosaicZoomTool::rubberBandComplete(), Isis::MosaicControlNetTool::updateTool(), Isis::MosaicFindTool::updateTool(), Isis::MosaicSelectTool::updateTool(), and Isis::MosaicZoomTool::updateTool().

Member Data Documentation

p_active

bool Isis::MosaicTool::p_active

private

Is the tool active?

Definition at line 120 of file MosaicTool.h.

Referenced by activate(), and isActive().

---

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

• src/qisis/objs/MosaicSceneWidget/MosaicTool.h
• src/qisis/objs/MosaicSceneWidget/MosaicTool.cpp