Isis 3 Programmer Reference
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Isis::MosaicPanTool Class Reference

Handles panning operations for Isis qt apps. More...

#include <MosaicPanTool.h>

Inheritance diagram for Isis::MosaicPanTool:
Inheritance graph
Collaboration diagram for Isis::MosaicPanTool:
Collaboration graph

Public Slots

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

Signals

void activated (bool)
 

Public Member Functions

 MosaicPanTool (MosaicSceneWidget *)
 MosaicPanTool constructor. More...
 
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

void updateTool ()
 

Protected Member Functions

QAction * getPrimaryAction ()
 Adds the action to the toolpad. More...
 
QWidget * createToolBarWidget ()
 Creates the widget to add to the tool bar. More...
 
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 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

Handles panning operations for Isis qt apps.

Author
????-??-?? Stacy Alley
History:
2011-05-07 Steven Lambright - Refactored along with all of 'qmos.' A lot of work still needs to be done for these tools.
History:
2011-09-27 Steven Lambright - Improved user documentation

Definition at line 22 of file MosaicPanTool.h.

Constructor & Destructor Documentation

◆ MosaicPanTool()

Isis::MosaicPanTool::MosaicPanTool ( MosaicSceneWidget *  scene)

MosaicPanTool constructor.

Parameters
parent

Definition at line 19 of file MosaicPanTool.cpp.

Member Function Documentation

◆ activate

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

Activates the tool.

Parameters
on

Definition at line 148 of file MosaicTool.cpp.

References Isis::MosaicTool::disableToolBar(), Isis::MosaicTool::enableToolBar(), and Isis::MosaicTool::p_active.

◆ createToolBarWidget()

QWidget * Isis::MosaicPanTool::createToolBarWidget ( )
protected

Creates the widget to add to the tool bar.

Parameters
parent
Returns
QWidget*

Definition at line 55 of file MosaicPanTool.cpp.

◆ disableToolBar()

void Isis::MosaicTool::disableToolBar ( )
privateinherited

Disables entire tool bar.

Definition at line 174 of file MosaicTool.cpp.

Referenced by Isis::MosaicTool::activate().

◆ enableToolBar()

void Isis::MosaicTool::enableToolBar ( )
privateinherited

Enables entire tool bar.

Definition at line 185 of file MosaicTool.cpp.

Referenced by Isis::MosaicTool::activate().

◆ getIcon()

QPixmap Isis::MosaicTool::getIcon ( QString  iconName) const
inherited

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(), getPrimaryAction(), Isis::MosaicSelectTool::getPrimaryAction(), Isis::MosaicZoomTool::getPrimaryAction(), and Isis::MosaicZoomTool::MosaicZoomTool().

◆ getPrimaryAction()

QAction * Isis::MosaicPanTool::getPrimaryAction ( )
protectedvirtual

Adds the action to the toolpad.

Parameters
toolpad
Returns
QAction*

Implements Isis::MosaicTool.

Definition at line 31 of file MosaicPanTool.cpp.

References Isis::MosaicTool::getIcon().

◆ getToolBarWidget()

QWidget * Isis::MosaicTool::getToolBarWidget ( )
protectedvirtualinherited

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
inlineinherited

Returns the activeness of this toool.

Returns
bool

Definition at line 50 of file MosaicTool.h.

References Isis::MosaicTool::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
privateinherited

Is the tool active?

Definition at line 120 of file MosaicTool.h.

Referenced by Isis::MosaicTool::activate(), and Isis::MosaicTool::isActive().

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