Public Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
pqSaveStateReaction Class Reference

Reaction for saving state file. More...

#include <pqSaveStateReaction.h>

Inheritance diagram for pqSaveStateReaction:
Inheritance graph
[legend]
Collaboration diagram for pqSaveStateReaction:
Collaboration graph
[legend]

Public Slots

void updateEnableState () override
 Updates the enabled state. More...
 

Public Member Functions

 pqSaveStateReaction (QAction *parent)
 Constructor. More...
 
 ~pqSaveStateReaction () override=default
 
- Public Member Functions inherited from pqReaction
 pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
 Constructor. More...
 
 ~pqReaction () override
 
QAction * parentAction () const
 Provides access to the parent action. More...
 

Static Public Member Functions

static bool saveState ()
 Open File dialog in order to choose the location and the type of the state file that should be saved Returns true if the user selected a file to save and false if they canceled the dialog. More...
 
static bool saveState (const QString &filename, vtkTypeUInt32 location=0x10)
 Saves the state file. More...
 
static bool savePythonState (const QString &filename, vtkTypeUInt32 location=0x10)
 Saves the state file as a python state. More...
 

Protected Member Functions

void onTriggered () override
 Called when the action is triggered. More...
 

Additional Inherited Members

- Protected Slots inherited from pqReaction
virtual void updateEnableState ()
 
virtual void updateMasterEnableState (bool)
 
- Protected Attributes inherited from pqReaction
bool IsMaster
 

Detailed Description

Reaction for saving state file.

Definition at line 14 of file pqSaveStateReaction.h.

Constructor & Destructor Documentation

◆ pqSaveStateReaction()

pqSaveStateReaction::pqSaveStateReaction ( QAction *  parent)

Constructor.

Parent cannot be nullptr.

◆ ~pqSaveStateReaction()

pqSaveStateReaction::~pqSaveStateReaction ( )
overridedefault

Member Function Documentation

◆ saveState() [1/2]

static bool pqSaveStateReaction::saveState ( )
static

Open File dialog in order to choose the location and the type of the state file that should be saved Returns true if the user selected a file to save and false if they canceled the dialog.

◆ saveState() [2/2]

static bool pqSaveStateReaction::saveState ( const QString &  filename,
vtkTypeUInt32  location = 0x10 
)
static

Saves the state file.

Note that this method is static. Applications can simply use this without having to create a reaction instance. Return true if the operation succeeded otherwise return false.

◆ savePythonState()

static bool pqSaveStateReaction::savePythonState ( const QString &  filename,
vtkTypeUInt32  location = 0x10 
)
static

Saves the state file as a python state.

Note that this method is static. Applications can simply use this without having to create a reaction instance. Return true if the operation succeeded otherwise return false.

◆ updateEnableState

void pqSaveStateReaction::updateEnableState ( )
overrideslot

Updates the enabled state.

Applications need not explicitly call this.

◆ onTriggered()

void pqSaveStateReaction::onTriggered ( )
inlineoverrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 61 of file pqSaveStateReaction.h.


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