PartDesignGui::TaskDlgFeaturePick Class Reference

simulation dialog for the TaskView More...

#include <TaskFeaturePick.h>

Public Member Functions

virtual bool accept ()
 is called by the framework if the dialog is accepted (Ok) More...
 
virtual void clicked (int)
 is called by the framework if an button is clicked which has no accept or reject role More...
 
virtual QDialogButtonBox::StandardButtons getStandardButtons (void) const
 returns for Close and Help button More...
 
virtual bool isAllowedAlterDocument (void) const
 is called by the framework if the user presses the help button More...
 
virtual void open ()
 is called the TaskView when the dialog is opened More...
 
virtual bool reject ()
 is called by the framework if the dialog is rejected (Cancel) More...
 
void showExternal (bool val)
 
 TaskDlgFeaturePick (std::vector< App::DocumentObject * > &objects, const std::vector< TaskFeaturePick::featureStatus > &status, std::function< bool(std::vector< App::DocumentObject * >)> acceptfunc, std::function< void(std::vector< App::DocumentObject * >)> workfunc, bool singleFeatureSelect, std::function< void(void)> abortfunc=0)
 
 ~TaskDlgFeaturePick ()
 
- Public Member Functions inherited from Gui::TaskView::TaskDialog
virtual bool accept ()
 is called by the framework if the dialog is accepted (Ok) More...
 
virtual void autoClosedOnTransactionChange ()
 is called by the framework when the dialog is automatically closed due to changing the active transaction More...
 
ButtonPosition buttonPosition () const
 
bool canClose () const
 
virtual void clicked (int)
 is called by the framework if a button is clicked which has no accept or reject role More...
 
virtual void closed ()
 is called by the framework when the dialog is closed More...
 
void emitDestructionSignal ()
 
const std::vector< QWidget * > & getDialogContent (void) const
 
const std::string & getDocumentName () const
 
virtual QDialogButtonBox::StandardButtons getStandardButtons (void) const
 tells the framework which buttons are wished for the dialog More...
 
virtual void helpRequested ()
 is called by the framework if the user press the help button More...
 
virtual bool isAllowedAlterDocument (void) const
 
virtual bool isAllowedAlterSelection (void) const
 
virtual bool isAllowedAlterView (void) const
 
bool isAutoCloseOnTransactionChange () const
 
bool isEscapeButtonEnabled () const
 
virtual void modifyStandardButtons (QDialogButtonBox *)
 
virtual bool needsFullSpace () const
 
virtual void open ()
 is called by the framework when the dialog is opened More...
 
virtual bool reject ()
 is called by the framework if the dialog is rejected (Cancel) More...
 
void setAutoCloseOnTransactionChange (bool on)
 Defines whether a task dialog must be closed if the document changed the active transaction. More...
 
void setButtonPosition (ButtonPosition p)
 
void setDocumentName (const std::string &doc)
 
void setEscapeButtonEnabled (bool on)
 Defines whether a task dialog can be rejected by pressing Esc. More...
 
 TaskDialog ()
 
 ~TaskDialog ()
 

Protected Attributes

std::function< void(void)> abortFunction
 
bool accepted
 
std::function< bool(std::vector< App::DocumentObject * >)> acceptFunction
 
TaskFeaturePickpick
 
std::function< void(std::vector< App::DocumentObject * >)> workFunction
 
- Protected Attributes inherited from Gui::TaskView::TaskDialog
std::vector< QWidget * > Content
 List of TaskBoxes of that dialog. More...
 
ButtonPosition pos
 

Additional Inherited Members

- Public Types inherited from Gui::TaskView::TaskDialog
enum  ButtonPosition { North , South }
 
- Signals inherited from Gui::TaskView::TaskDialog
void aboutToBeDestroyed ()
 

Detailed Description

simulation dialog for the TaskView

Constructor & Destructor Documentation

◆ TaskDlgFeaturePick()

TaskDlgFeaturePick::TaskDlgFeaturePick ( std::vector< App::DocumentObject * > &  objects,
const std::vector< TaskFeaturePick::featureStatus > &  status,
std::function< bool(std::vector< App::DocumentObject * >)>  acceptfunc,
std::function< void(std::vector< App::DocumentObject * >)>  workfunc,
bool  singleFeatureSelect,
std::function< void(void)>  abortfunc = 0 
)

◆ ~TaskDlgFeaturePick()

Member Function Documentation

◆ accept()

◆ clicked()

void TaskDlgFeaturePick::clicked ( int  )
virtual

is called by the framework if an button is clicked which has no accept or reject role

Reimplemented from Gui::TaskView::TaskDialog.

◆ getStandardButtons()

virtual QDialogButtonBox::StandardButtons PartDesignGui::TaskDlgFeaturePick::getStandardButtons ( void  ) const
virtual

returns for Close and Help button

Reimplemented from Gui::TaskView::TaskDialog.

◆ isAllowedAlterDocument()

virtual bool PartDesignGui::TaskDlgFeaturePick::isAllowedAlterDocument ( void  ) const
virtual

is called by the framework if the user presses the help button

Reimplemented from Gui::TaskView::TaskDialog.

◆ open()

void TaskDlgFeaturePick::open ( )
virtual

is called the TaskView when the dialog is opened

Reimplemented from Gui::TaskView::TaskDialog.

◆ reject()

◆ showExternal()

void TaskDlgFeaturePick::showExternal ( bool  val)

Member Data Documentation

◆ abortFunction

std::function<void (void)> PartDesignGui::TaskDlgFeaturePick::abortFunction
protected

◆ accepted

bool PartDesignGui::TaskDlgFeaturePick::accepted
protected

Referenced by accept(), reject(), and ~TaskDlgFeaturePick().

◆ acceptFunction

std::function<bool (std::vector<App::DocumentObject*>)> PartDesignGui::TaskDlgFeaturePick::acceptFunction
protected

Referenced by accept(), and TaskDlgFeaturePick().

◆ pick

TaskFeaturePick* PartDesignGui::TaskDlgFeaturePick::pick
protected

◆ workFunction

std::function<void (std::vector<App::DocumentObject*>)> PartDesignGui::TaskDlgFeaturePick::workFunction
protected

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