Isis::HelpTool Class Reference

Qisis Help Tool. More...

#include <HelpTool.h>

Inherits Isis::Tool.

Public Slots
void	whatsThis ()
void	activate (bool)
	Activates the tool.
virtual void	updateTool ()
	Updates the tool.
void	setCubeViewport (MdiCubeViewport *cvp)
	Sets the current viewport to the given cvp.

Signals
void	clearWarningSignal ()
void	toolActivated ()
void	viewportChanged ()

Public Member Functions
	HelpTool (QWidget *parent)
void	addTo (QMenu *menu)
void	addToPermanent (QToolBar *perm)
	Add actions to the permanent toolbar.
QString	menuName () const
	Anytime a tool is created, you must give it a name for the menu.
void	addTo (ViewportMainWindow *mw)
	Adds the tool to the application.
void	addTo (ToolPad *toolpad)
	Adds the tool to the toolpad.
virtual void	addTo (Workspace *ws)
	Adds the given workspace to the cubeviewport list.
void	addToActive (QToolBar *toolbar)
QString	toolIconDir () const
	returns the path to the icon directory.
virtual void	paintViewport (MdiCubeViewport *vp, QPainter *painter)
RubberBandTool *	rubberBandTool ()
void	setList (ToolList *currentList)

Protected Types
typedef QVector < MdiCubeViewport * >	CubeViewportList
	A list of cubeviewports.

Protected Slots
virtual void	rubberBandComplete ()
virtual void	screenPixelsChanged ()
	This is called when actions change which pixels from the cube are displayed.
virtual void	mouseEnter ()
virtual void	mouseMove (QPoint p)
virtual void	mouseMove (QPoint p, Qt::MouseButton)
virtual void	mouseLeave ()
virtual void	mouseDoubleClick (QPoint p)
virtual void	mouseButtonPress (QPoint p, Qt::MouseButton s)
virtual void	mouseButtonRelease (QPoint p, Qt::MouseButton s)
	Resets the Warning to Nowarning when a different activity occurs on the application.
virtual void	updateMeasure ()
virtual void	scaleChanged ()
virtual void	stretchRequested (MdiCubeViewport *, int)
void	registerTool (MdiCubeViewport *viewport)
	Registers the tool to the viewport.

Protected Member Functions
MdiCubeViewport *	cubeViewport () const
	Return the current cubeviewport.
CubeViewportList *	cubeViewportList () const
	Return the list of cubeviewports.
virtual QAction *	toolPadAction (ToolPad *toolpad)
	Anytime a tool is created, you must setup a tool pad action with it.
virtual QWidget *	createToolBarWidget (QStackedWidget *parent)
	Anytime a tool is created, you must add it to the tool bar.
virtual void	addConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must add the connections for it.
virtual void	removeConnections (MdiCubeViewport *cvp)
	Anytime a tool is created, you must be able to remove it's connections.
virtual void	enableRubberBandTool ()
	Anytime a tool is created, you may use the rubber band tool.
Workspace *	workspace ()

Detailed Description

Qisis Help Tool.

Author

????-??-?? Jeff Anderson

Member Typedef Documentation

typedef QVector< MdiCubeViewport * > Isis::Tool::CubeViewportList

protectedinherited

A list of cubeviewports.

Constructor & Destructor Documentation

Isis::HelpTool::HelpTool

(

QWidget *

parent

)

References Isis::Tool::toolIconDir(), and whatsThis().

Member Function Documentation

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

slotinherited

Activates the tool.

Parameters

on

References Isis::Tool::clearWarningSignal(), and Isis::Tool::toolActivated().

Referenced by Isis::Tool::addTo(), Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::RubberBandTool::disable(), Isis::RubberBandTool::enable(), Isis::AdvancedTrackTool::eventFilter(), Isis::FileTool::FileTool(), Isis::RubberBandTool::RubberBandTool(), Isis::TrackTool::TrackTool(), Isis::WindowTool::WindowTool(), and Isis::Workspace::Workspace().

virtual void Isis::Tool::addConnections ( MdiCubeViewport *  cvp )

inlineprotectedvirtualinherited

Anytime a tool is created, you must add the connections for it.

Parameters

cvp

Reimplemented in Isis::TrackTool, and Isis::WindowTool.

void Isis::HelpTool::addTo ( QMenu *  menu )

virtual

Parameters

menu

Reimplemented from Isis::Tool.

void Isis::Tool::addTo ( ViewportMainWindow *  pViewPortMnWin )

inherited

Adds the tool to the application.

Parameters

pViewPortMnWin

References Isis::ViewportMainWindow::activeToolBar(), Isis::Tool::addToActive(), Isis::Tool::addToPermanent(), Isis::ViewportMainWindow::getMenu(), Isis::Tool::menuName(), Isis::ViewportMainWindow::permanentToolBar(), Isis::ViewportMainWindow::toolPad(), and Isis::ViewportMainWindow::workspace().

Referenced by Isis::ViewportMainWindow::ViewportMainWindow(), and Isis::Workspace::Workspace().

void Isis::Tool::addTo ( ToolPad *  toolpad )

inherited

Adds the tool to the toolpad.

Parameters

toolpad

References Isis::Tool::activate(), Isis::ToolPad::addAction(), and Isis::Tool::toolPadAction().

void Isis::Tool::addTo ( Workspace *  ws )

virtualinherited

Adds the given workspace to the cubeviewport list.

Parameters

ws

Reimplemented in Isis::EditTool, Isis::FileTool, Isis::SpecialPixelTool, and Isis::WindowTool.

References Isis::Tool::registerTool(), and Isis::Tool::setCubeViewport().

void Isis::Tool::addToActive ( QToolBar *  toolbar )

inherited

Parameters

toolbar

References Isis::Tool::createToolBarWidget(), and Isis::ToolList::toolBarStack().

Referenced by Isis::Tool::addTo(), and Isis::Workspace::Workspace().

void Isis::HelpTool::addToPermanent ( QToolBar *  perm )

virtual

Add actions to the permanent toolbar.

Reimplemented from Isis::Tool.

void Isis::Tool::clearWarningSignal ( )

signalinherited

Referenced by Isis::Tool::activate(), Isis::Tool::mouseButtonPress(), Isis::Tool::mouseButtonRelease(), and Isis::Tool::mouseDoubleClick().

virtual QWidget* Isis::Tool::createToolBarWidget ( QStackedWidget *  parent )

inlineprotectedvirtualinherited

Anytime a tool is created, you must add it to the tool bar.

Parameters

parent

Returns

QWidget*

Reimplemented in Isis::StretchTool, Isis::FindTool, Isis::StatisticsTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::ZoomTool, Isis::MeasureTool, Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::AbstractPlotTool, Isis::BandTool, Isis::SunShadowTool, Isis::ScatterPlotTool, Isis::HistogramTool, and Isis::PanTool.

Referenced by Isis::Tool::addToActive().

MdiCubeViewport* Isis::Tool::cubeViewport ( ) const

inlineprotectedinherited

Return the current cubeviewport.

Returns

CubeViewport*

Referenced by Isis::WindowTool::addConnections(), Isis::TrackTool::addConnections(), Isis::FileTool::discard(), Isis::FileTool::exportView(), Isis::SunShadowTool::mouseButtonPress(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::EditTool::mouseButtonRelease(), Isis::FeatureNomenclatureTool::mouseButtonRelease(), Isis::FindTool::mouseButtonRelease(), Isis::StretchTool::mouseButtonRelease(), Isis::MatchTool::mouseButtonRelease(), Isis::QnetTool::mouseButtonRelease(), Isis::AdvancedTrackTool::mouseLeave(), Isis::ScatterPlotTool::mouseMove(), Isis::SunShadowTool::mouseMove(), Isis::TrackTool::mouseMove(), Isis::RubberBandTool::mouseMove(), Isis::SunShadowTool::paintViewport(), Isis::RubberBandTool::paintViewport(), Isis::FindTool::paintViewport(), Isis::FileTool::print(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::WindowTool::removeConnections(), Isis::TrackTool::removeConnections(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), Isis::FileTool::save(), Isis::FileTool::saveAs(), Isis::FileTool::saveAsCubeByOption(), Isis::FileTool::saveInfo(), Isis::ScatterPlotTool::showNewScatterPlotConfig(), Isis::StretchTool::stretchGlobal(), Isis::StretchTool::stretchGlobalAllBands(), Isis::StretchTool::stretchRegional(), Isis::StretchTool::updateAdvStretchDialogforAll(), Isis::StretchTool::updateHistograms(), Isis::MeasureTool::updateMeasure(), Isis::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::SpecialPixelTool::updateTool(), Isis::SunShadowTool::updateTool(), Isis::BandTool::updateTool(), Isis::AbstractPlotTool::updateTool(), Isis::ZoomTool::updateTool(), Isis::FileTool::updateTool(), Isis::EditTool::updateTool(), Isis::FindTool::updateTool(), Isis::StretchTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

Tool::CubeViewportList * Isis::Tool::cubeViewportList ( ) const

protectedinherited

Return the list of cubeviewports.

Returns

CubeViewportList*

References Isis::Workspace::cubeViewportList().

Referenced by Isis::FileTool::closeAll(), Isis::MatchTool::createPoint(), Isis::BlinkTool::eventFilter(), Isis::PanTool::mouseButtonRelease(), Isis::RubberBandTool::mouseButtonRelease(), Isis::RubberBandTool::mouseMove(), Isis::ScatterPlotTool::repaintViewports(), Isis::AbstractPlotTool::repaintViewports(), Isis::ZoomTool::rubberBandComplete(), Isis::FeatureNomenclatureTool::setFontColor(), Isis::FeatureNomenclatureTool::setFontSize(), Isis::FeatureNomenclatureTool::setShowApprovedOnly(), Isis::FeatureNomenclatureTool::setVectorType(), Isis::StretchTool::stretchGlobalAllViewports(), Isis::MeasureTool::updateMeasure(), Isis::WindowTool::updateTool(), Isis::BlinkTool::updateTool(), Isis::FindTool::updateTool(), and Isis::AbstractPlotTool::viewportsToPlot().

void Isis::Tool::enableRubberBandTool ( )

protectedvirtualinherited

Anytime a tool is created, you may use the rubber band tool.

Enable the use of the rubberband tool.

Reimplemented in Isis::RubberBandTool, Isis::ZoomTool, Isis::MeasureTool, Isis::StereoTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, and Isis::HistogramTool.

References Isis::RubberBandTool::disable(), and Isis::Tool::rubberBandTool().

QString Isis::HelpTool::menuName ( ) const

inlinevirtual

Anytime a tool is created, you must give it a name for the menu.

Returns

QString

Reimplemented from Isis::Tool.

void Isis::Tool::mouseButtonPress ( QPoint  p, Qt::MouseButton  s  )

protectedvirtualslotinherited

Parameters

p
s

References Isis::Tool::clearWarningSignal().

void Isis::Tool::mouseButtonRelease ( QPoint  p, Qt::MouseButton  s  )

protectedvirtualslotinherited

Resets the Warning to Nowarning when a different activity occurs on the application.

This is called by all the mouseButtonRelease events in all the tools.

Parameters

p
s

Reimplemented in Isis::FeatureNomenclatureTool.

References Isis::Tool::clearWarningSignal().

void Isis::Tool::mouseDoubleClick ( QPoint  p )

protectedvirtualslotinherited

Parameters

p

References Isis::Tool::clearWarningSignal().

virtual void Isis::Tool::mouseEnter ( )

inlineprotectedvirtualslotinherited

virtual void Isis::Tool::mouseLeave ( )

inlineprotectedvirtualslotinherited

void Isis::Tool::mouseMove ( QPoint  p )

protectedvirtualslotinherited

Parameters

p

virtual void Isis::Tool::mouseMove ( QPoint  p, Qt::MouseButton    )

inlineprotectedvirtualslotinherited

virtual void Isis::Tool::paintViewport ( MdiCubeViewport *  vp, QPainter *  painter  )

inlinevirtualinherited

Parameters

vp
painter

Reimplemented in Isis::QnetTool, Isis::MatchTool, Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::RubberBandTool, Isis::StereoTool, Isis::SunShadowTool, Isis::AbstractPlotTool, and Isis::ScatterPlotTool.

void Isis::Tool::registerTool ( MdiCubeViewport *  viewport )

protectedslotinherited

Registers the tool to the viewport.

Parameters

viewport

References Isis::MdiCubeViewport::registerTool(), and Isis::Tool::stretchRequested().

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::removeConnections ( MdiCubeViewport *  cvp )

inlineprotectedvirtualinherited

Anytime a tool is created, you must be able to remove it's connections.

Parameters

cvp

Reimplemented in Isis::MeasureTool, Isis::TrackTool, and Isis::WindowTool.

virtual void Isis::Tool::rubberBandComplete ( )

inlineprotectedvirtualslotinherited

RubberBandTool * Isis::Tool::rubberBandTool ( )

inherited

References Isis::ToolList::rubberBandTool().

Referenced by Isis::MeasureTool::createToolBarWidget(), Isis::HistogramTool::enableRubberBandTool(), Isis::SpectralPlotTool::enableRubberBandTool(), Isis::SpatialPlotTool::enableRubberBandTool(), Isis::StereoTool::enableRubberBandTool(), Isis::MeasureTool::enableRubberBandTool(), Isis::ZoomTool::enableRubberBandTool(), Isis::EditTool::enableRubberBandTool(), Isis::StretchTool::enableRubberBandTool(), Isis::Tool::enableRubberBandTool(), Isis::HistogramTool::refreshPlot(), Isis::SpatialPlotTool::refreshPlot(), Isis::SpectralPlotTool::refreshPlot(), Isis::RubberBandComboBox::RubberBandComboBox(), Isis::HistogramTool::rubberBandComplete(), Isis::MeasureTool::rubberBandComplete(), Isis::SpectralPlotTool::rubberBandComplete(), Isis::SpatialPlotTool::rubberBandComplete(), Isis::StereoTool::rubberBandComplete(), Isis::ZoomTool::rubberBandComplete(), Isis::EditTool::rubberBandComplete(), Isis::StretchTool::rubberBandComplete(), and Isis::RubberBandComboBox::selectionChanged().

virtual void Isis::Tool::scaleChanged ( )

inlineprotectedvirtualslotinherited

Reimplemented in Isis::RubberBandTool.

virtual void Isis::Tool::screenPixelsChanged ( )

inlineprotectedvirtualslotinherited

This is called when actions change which pixels from the cube are displayed.

void Isis::Tool::setCubeViewport ( MdiCubeViewport *  cvp )

slotinherited

Sets the current viewport to the given cvp.

Parameters

cvp

References Isis::Tool::updateTool(), and Isis::Tool::viewportChanged().

Referenced by Isis::Tool::addTo(), and Isis::FileTool::closeAll().

void Isis::Tool::setList ( ToolList *  currentList )

inherited

Referenced by Isis::ToolList::append().

virtual void Isis::Tool::stretchRequested ( MdiCubeViewport *  , int    )

inlineprotectedvirtualslotinherited

Reimplemented in Isis::StretchTool.

Referenced by Isis::Tool::registerTool().

void Isis::Tool::toolActivated ( )

signalinherited

Referenced by Isis::Tool::activate(), Isis::FeatureNomenclatureTool::FeatureNomenclatureTool(), Isis::MatchTool::MatchTool(), and Isis::StereoTool::StereoTool().

QString Isis::Tool::toolIconDir ( ) const

inlineinherited

returns the path to the icon directory.

Returns

QString

Referenced by Isis::AdvancedTrackTool::AdvancedTrackTool(), Isis::BlinkTool::BlinkTool(), Isis::PanTool::createToolBarWidget(), Isis::BandTool::createToolBarWidget(), Isis::StereoTool::createToolBarWidget(), Isis::ZoomTool::createToolBarWidget(), Isis::EditTool::createToolBarWidget(), Isis::FindTool::createToolBarWidget(), Isis::StretchTool::createToolBarWidget(), Isis::MatchTool::createToolBarWidget(), Isis::FileTool::FileTool(), Isis::FindTool::FindTool(), HelpTool(), Isis::HistogramTool::HistogramTool(), Isis::PanTool::PanTool(), Isis::SpecialPixelTool::SpecialPixelTool(), Isis::RubberBandComboBox::toolIconDir(), Isis::PanTool::toolPadAction(), Isis::HistogramTool::toolPadAction(), Isis::ScatterPlotTool::toolPadAction(), Isis::BandTool::toolPadAction(), Isis::SunShadowTool::toolPadAction(), Isis::SpectralPlotTool::toolPadAction(), Isis::SpatialPlotTool::toolPadAction(), Isis::StereoTool::toolPadAction(), Isis::MeasureTool::toolPadAction(), Isis::ZoomTool::toolPadAction(), Isis::EditTool::toolPadAction(), Isis::FeatureNomenclatureTool::toolPadAction(), Isis::StatisticsTool::toolPadAction(), Isis::FindTool::toolPadAction(), Isis::StretchTool::toolPadAction(), Isis::MatchTool::toolPadAction(), Isis::QnetTool::toolPadAction(), Isis::WindowTool::WindowTool(), and Isis::ZoomTool::ZoomTool().

virtual QAction* Isis::Tool::toolPadAction ( ToolPad *  toolpad )

inlineprotectedvirtualinherited

Anytime a tool is created, you must setup a tool pad action with it.

Parameters

toolpad

Returns

QAction*

Reimplemented in Isis::QnetTool, Isis::MatchTool, Isis::StretchTool, Isis::FindTool, Isis::StatisticsTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::ZoomTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::StereoTool, Isis::SpectralPlotTool, Isis::BandTool, Isis::SunShadowTool, Isis::ScatterPlotTool, Isis::HistogramTool, and Isis::PanTool.

Referenced by Isis::Tool::addTo().

virtual void Isis::Tool::updateMeasure ( )

inlineprotectedvirtualslotinherited

void Isis::Tool::updateTool ( )

virtualslotinherited

Updates the tool.

Reimplemented in Isis::StretchTool, Isis::FindTool, Isis::FeatureNomenclatureTool, Isis::EditTool, Isis::FileTool, Isis::ZoomTool, Isis::MeasureTool, Isis::SpatialPlotTool, Isis::SpectralPlotTool, Isis::AbstractPlotTool, Isis::BandTool, Isis::SunShadowTool, Isis::SpecialPixelTool, Isis::BlinkTool, Isis::HistogramTool, and Isis::WindowTool.

Referenced by Isis::Tool::setCubeViewport().

void Isis::Tool::viewportChanged ( )

signalinherited

Referenced by Isis::Tool::setCubeViewport(), Isis::SpatialPlotTool::SpatialPlotTool(), Isis::SpectralPlotTool::SpectralPlotTool(), and Isis::SunShadowTool::SunShadowTool().

void Isis::HelpTool::whatsThis ( )

slot

Referenced by HelpTool().

Workspace * Isis::Tool::workspace ( )

protectedinherited

Referenced by Isis::ScatterPlotTool::showNewScatterPlotConfig().

---

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

• src/qisis/objs/HelpTool/HelpTool.h
• src/qisis/objs/HelpTool/HelpTool.cpp