Isis Developer Reference
Isis::FileTool Class Reference

#include <FileTool.h>

Inheritance diagram for Isis::FileTool:
Inheritance graph
Collaboration diagram for Isis::FileTool:
Collaboration graph

Public Slots

virtual void open ()
 This method allows the user to navigate and open a cube with a file dialog. More...
 
virtual void browse ()
 This method allows the user to navigate and browse cubes with a file dialog . More...
 
void print ()
 This method allows the user to print the current viewport. More...
 
virtual void save ()
 This method saves any changes made to the current cube, these changes are finalized! There is no undoing once a save has been made. More...
 
virtual void saveAs ()
 SaveAs Action - Displays the FileDialog with the filterlist (*.cub) to select the output cube. More...
 
virtual void saveInfo ()
 Saves the whatsthis info of the cubeviewport. More...
 
virtual void exportView ()
 This method allows the user to export the current view as an image file. More...
 
virtual void exportToList ()
 FileTool::exportToList. More...
 
virtual bool closeAll ()
 Try to close all open cubes and save/discard if necessary. More...
 
virtual void exit ()
 Exit the program, this slot called when the exit is chosen from the File menu. More...
 
void enableSave (bool enable)
 This slot enables or disables save and save as. More...
 
void discard ()
 This slot emits a signal to discard all changes to the current viewport. More...
 
void saveAsCubeByOption (QString)
 Save as Isis Cube (FullImage, AsIs, FullRes) More...
 
void activate (bool)
 Activates the tool. More...
 
void setCubeViewport (MdiCubeViewport *cvp)
 Sets the current viewport to the given cvp. More...
 

Signals

void fileSelected (QString)
 This signal is called when a file is selected. More...
 
void saveChanges (CubeViewport *vp)
 This signal is called when changes should be saved. More...
 
void discardChanges (CubeViewport *vp)
 This signal is called when changes should be discarded. More...
 
void clearWarningSignal ()
 
void toolActivated ()
 
void viewportChanged ()
 

Public Member Functions

 FileTool (QWidget *parent)
 Constructs a FileTool object. More...
 
void addTo (QMenu *menu)
 Adds the file tool's actions to the menu. More...
 
void addTo (Workspace *ws)
 Connects the fileSelected signal to the workspace's addCubeViewport slot. More...
 
void addToPermanent (QToolBar *perm)
 Adds the file tool's actions to the permanent toolbar. More...
 
QPointer< QActionopenAction ()
 
QPointer< QActionsaveAction ()
 
QString menuName () const
 
void addTo (ViewportMainWindow *mw)
 Adds the tool to the application. More...
 
void addTo (ToolPad *toolpad)
 Adds the tool to the toolpad. More...
 
void addToActive (QToolBar *toolbar)
 
QString toolIconDir () const
 returns the path to the icon directory. More...
 
virtual void paintViewport (MdiCubeViewport *vp, QPainter *painter)
 
RubberBandToolrubberBandTool ()
 
void setList (ToolList *currentList)
 

Public Attributes

QStringList p_filterList
 Filter List. More...
 
QDir p_dir
 Directory. More...
 
QStringList p_fileList
 File list. More...
 

Protected Types

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

Protected Slots

virtual void rubberBandComplete ()
 
virtual void screenPixelsChanged ()
 This is called when actions change which pixels from the cube are displayed. More...
 
virtual void mouseEnter ()
 
virtual void mouseMove (QPoint p)
 
virtual void mouseMove (QPoint p, Qt::MouseButton)
 
virtual void mouseLeave ()
 

Protected Member Functions

void updateTool ()
 Updates the tool. More...
 
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. More...
 
virtual void updateMeasure ()
 
virtual void scaleChanged ()
 
virtual void stretchRequested (MdiCubeViewport *, int)
 
void registerTool (MdiCubeViewport *viewport)
 Registers the tool to the viewport. More...
 
MdiCubeViewportcubeViewport () const
 Return the current cubeviewport. More...
 
CubeViewportListcubeViewportList () const
 Return the list of cubeviewports. More...
 
virtual QActiontoolPadAction (ToolPad *toolpad)
 Anytime a tool is created, you must setup a tool pad action with it. More...
 
virtual QWidgetcreateToolBarWidget (QStackedWidget *parent)
 Anytime a tool is created, you must add it to the tool bar. More...
 
virtual void addConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must add the connections for it. More...
 
virtual void removeConnections (MdiCubeViewport *cvp)
 Anytime a tool is created, you must be able to remove it's connections. More...
 
virtual void enableRubberBandTool ()
 Anytime a tool is created, you may use the rubber band tool. More...
 
Workspaceworkspace ()
 

Detailed Description

Author
????-??-?? Unknown

Member Typedef Documentation

◆ CubeViewportList

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

A list of cubeviewports.

Constructor & Destructor Documentation

◆ FileTool()

Isis::FileTool::FileTool ( QWidget parent)

Member Function Documentation

◆ activate

◆ addConnections()

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::WindowTool, and Isis::TrackTool.

◆ addTo() [1/4]

void Isis::FileTool::addTo ( QMenu menu)
virtual

Adds the file tool's actions to the menu.

Parameters
menu

Reimplemented from Isis::Tool.

Reimplemented in Isis::QnetFileTool.

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

◆ addTo() [2/4]

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().

◆ addTo() [3/4]

◆ addTo() [4/4]

void Isis::FileTool::addTo ( Workspace ws)
virtual

Connects the fileSelected signal to the workspace's addCubeViewport slot.

Parameters
ws

Reimplemented from Isis::Tool.

References Isis::Tool::addTo(), fileSelected(), and Isis::Workspace::mdiArea().

◆ addToActive()

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

◆ addToPermanent()

void Isis::FileTool::addToPermanent ( QToolBar perm)
virtual

Adds the file tool's actions to the permanent toolbar.

Parameters
perm

Reimplemented from Isis::Tool.

◆ browse

void Isis::FileTool::browse ( )
virtualslot

This method allows the user to navigate and browse cubes with a file dialog .

References fileSelected(), p_dir, and p_filterList.

Referenced by FileTool().

◆ clearWarningSignal

void Isis::Tool::clearWarningSignal ( )
signalinherited

◆ closeAll

bool Isis::FileTool::closeAll ( )
virtualslot

Try to close all open cubes and save/discard if necessary.

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

◆ createToolBarWidget()

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

◆ cubeViewport()

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

Return the current cubeviewport.

Returns
CubeViewport*

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

◆ cubeViewportList()

◆ discard

void Isis::FileTool::discard ( )
slot

This slot emits a signal to discard all changes to the current viewport.

References Isis::Tool::cubeViewport(), and discardChanges().

Referenced by updateTool().

◆ discardChanges

void Isis::FileTool::discardChanges ( CubeViewport vp)
signal

This signal is called when changes should be discarded.

Parameters
vp

Referenced by discard(), and updateTool().

◆ enableRubberBandTool()

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::ZoomTool, Isis::StereoTool, Isis::SpectralPlotTool, Isis::SpatialPlotTool, Isis::RubberBandTool, Isis::MeasureTool, and Isis::HistogramTool.

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

◆ enableSave

void Isis::FileTool::enableSave ( bool  enable)
slot

This slot enables or disables save and save as.

Parameters
enable

◆ exit

void Isis::FileTool::exit ( )
virtualslot

Exit the program, this slot called when the exit is chosen from the File menu.

Referenced by FileTool().

◆ exportToList

void Isis::FileTool::exportToList ( )
virtualslot

FileTool::exportToList.

This method exports the file names of all active cubes into a .lis file by looping through The ViewportMainWindow and grabbing the file names from the active child CubeViewports.

Author
Adam Goins

References Isis::CubeViewport::cube(), Isis::Tool::cubeViewport(), and Isis::Cube::fileName().

Referenced by FileTool().

◆ exportView

void Isis::FileTool::exportView ( )
virtualslot

This method allows the user to export the current view as an image file.

References Isis::Tool::cubeViewport().

Referenced by FileTool().

◆ fileSelected

void Isis::FileTool::fileSelected ( QString  )
signal

This signal is called when a file is selected.

Referenced by addTo(), browse(), Isis::QnetFileTool::loadImage(), open(), saveAs(), and saveAsCubeByOption().

◆ menuName()

QString Isis::FileTool::menuName ( ) const
inlinevirtual
Returns
the menu name for the file tool

Reimplemented from Isis::Tool.

◆ mouseButtonPress()

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

References Isis::Tool::clearWarningSignal().

◆ mouseButtonRelease()

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

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().

Referenced by Isis::StretchTool::mouseButtonRelease().

◆ mouseDoubleClick()

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

References Isis::Tool::clearWarningSignal().

◆ mouseEnter

virtual void Isis::Tool::mouseEnter ( )
inlineprotectedvirtualslotinherited

◆ mouseLeave

virtual void Isis::Tool::mouseLeave ( )
inlineprotectedvirtualslotinherited

◆ mouseMove [1/2]

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

◆ mouseMove [2/2]

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

◆ open

void Isis::FileTool::open ( )
virtualslot

This method allows the user to navigate and open a cube with a file dialog.

References fileSelected(), p_dir, and p_filterList.

Referenced by FileTool().

◆ openAction()

QPointer<QAction> Isis::FileTool::openAction ( )
inline
Returns
the open action

Referenced by Isis::QnetFileTool::QnetFileTool().

◆ paintViewport()

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

◆ print

void Isis::FileTool::print ( )
slot

This method allows the user to print the current viewport.

References Isis::Tool::cubeViewport().

Referenced by FileTool().

◆ registerTool()

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

Registers the tool to the viewport.

Parameters
viewport

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

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

◆ removeConnections()

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::WindowTool, Isis::TrackTool, and Isis::MeasureTool.

◆ rubberBandComplete

virtual void Isis::Tool::rubberBandComplete ( )
inlineprotectedvirtualslotinherited

◆ rubberBandTool()

◆ save

void Isis::FileTool::save ( )
virtualslot

This method saves any changes made to the current cube, these changes are finalized! There is no undoing once a save has been made.

References Isis::CubeViewport::cube(), Isis::Tool::cubeViewport(), Isis::Cube::reopen(), and saveChanges().

Referenced by FileTool(), saveAsCubeByOption(), and updateTool().

◆ saveAction()

QPointer<QAction> Isis::FileTool::saveAction ( )
inline
Returns
the save as action

Referenced by Isis::QnetFileTool::QnetFileTool().

◆ saveAs

void Isis::FileTool::saveAs ( )
virtualslot

SaveAs Action - Displays the FileDialog with the filterlist (*.cub) to select the output cube.

This dialog additionally displays radio buttons for choices FullImage, ExportAsIs, ExportFullRes. These choices are located at the bottom of the dialog. FullImage - copies the entire image into the user specified output file ExportAsIs - copies the image as displayed in the qview app window ExportFullRes - copies the image as displayed in the qview app window but with full resolution

Author
Sharmila Prasad (4/8/2011)

References Isis::Tool::cubeViewport(), fileSelected(), p_dir, p_filterList, and saveAsCubeByOption().

Referenced by FileTool().

◆ saveAsCubeByOption

void Isis::FileTool::saveAsCubeByOption ( QString  psOutFile)
slot

Save as Isis Cube (FullImage, AsIs, FullRes)

Save input image as a cube into specified output file as FullImage or ExportAsIs or ExportFullRes option.

Author
Sharmila Prasad (4/8/2011)
Parameters
psOutFile- user specified output file

References Isis::Cube::bandCount(), Isis::Cube::close(), Isis::Tool::cubeViewport(), Isis::SaveAsDialog::ExportAsIs, Isis::SaveAsDialog::ExportFullRes, fileSelected(), Isis::SaveAsDialog::FullImage, Isis::Cube::lineCount(), Isis::Cube::open(), Isis::Cube::sampleCount(), and save().

Referenced by saveAs().

◆ saveChanges

void Isis::FileTool::saveChanges ( CubeViewport vp)
signal

This signal is called when changes should be saved.

Parameters
vp

Referenced by save(), and updateTool().

◆ saveInfo

void Isis::FileTool::saveInfo ( void  )
virtualslot

Saves the whatsthis info of the cubeviewport.

Saves the whatsthis info of the cubeviewport to user specified output file.

Author
Sharmila Prasad (4/6/2011)

References Isis::Tool::cubeViewport(), Isis::CubeViewport::getAllWhatsThisInfo(), and Isis::Pvl::write().

Referenced by FileTool().

◆ scaleChanged()

virtual void Isis::Tool::scaleChanged ( )
inlineprotectedvirtualinherited

Reimplemented in Isis::RubberBandTool.

◆ screenPixelsChanged

virtual void Isis::Tool::screenPixelsChanged ( )
inlineprotectedvirtualslotinherited

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

◆ setCubeViewport

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 closeAll().

◆ setList()

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

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

◆ stretchRequested()

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

Reimplemented in Isis::StretchTool.

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

◆ toolActivated

◆ toolIconDir()

◆ toolPadAction()

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

◆ updateMeasure()

virtual void Isis::Tool::updateMeasure ( )
inlineprotectedvirtualinherited

◆ updateTool()

void Isis::FileTool::updateTool ( )
protectedvirtual

Updates the tool.

This method is called when the tool is updated.

Reimplemented from Isis::Tool.

References Isis::Tool::cubeViewport(), discard(), discardChanges(), save(), and saveChanges().

◆ viewportChanged

◆ workspace()

Member Data Documentation

◆ p_dir

QDir Isis::FileTool::p_dir

Directory.

Referenced by browse(), FileTool(), open(), and saveAs().

◆ p_fileList

QStringList Isis::FileTool::p_fileList

File list.

◆ p_filterList

QStringList Isis::FileTool::p_filterList

Filter List.

Referenced by browse(), open(), and saveAs().


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