+ fix documentation of task dialog

This commit is contained in:
wmayer 2015-11-09 19:22:19 +01:00
parent d3280a0b82
commit dff58e5df3
12 changed files with 41 additions and 9 deletions

View File

@ -79,8 +79,20 @@ public:
QTabWidget* tabPanel() const;
//@}
/*!
If a task dialog is open then it indicates whether this task dialog allows other commands to modify
the document while it is open. If no task dialog is open true is returned.
*/
bool isAllowedAlterDocument(void) const;
/*!
If a task dialog is open then it indicates whether this task dialog allows other commands to modify
the 3d view while it is open. If no task dialog is open true is returned.
*/
bool isAllowedAlterView(void) const;
/*!
If a task dialog is open then it indicates whether this task dialog allows other commands to modify
the selection while it is open. If no task dialog is open true is returned.
*/
bool isAllowedAlterSelection(void) const;
public Q_SLOTS:

View File

@ -71,10 +71,22 @@ public:
{ return documentName; }
void setDocumentName(const std::string& doc)
{ documentName = doc; }
/*!
Indicates whether this task dialog allows other commands to modify
the document while it is open.
*/
virtual bool isAllowedAlterDocument(void) const
{ return false; }
/*!
Indicates whether this task dialog allows other commands to modify
the 3d view while it is open.
*/
virtual bool isAllowedAlterView(void) const
{ return true; }
/*!
Indicates whether this task dialog allows other commands to modify
the selection while it is open.
*/
virtual bool isAllowedAlterSelection(void) const
{ return true; }
virtual bool needsFullSpace() const

View File

@ -75,16 +75,33 @@ public:
virtual QDialogButtonBox::StandardButtons getStandardButtons(void) const;
virtual void modifyStandardButtons(QDialogButtonBox*);
/*!
Indicates whether this task dialog allows other commands to modify
the document while it is open.
*/
virtual bool isAllowedAlterDocument(void) const;
/*!
Indicates whether this task dialog allows other commands to modify
the 3d view while it is open.
*/
virtual bool isAllowedAlterView(void) const;
/*!
Indicates whether this task dialog allows other commands to modify
the selection while it is open.
*/
virtual bool isAllowedAlterSelection(void) const;
virtual bool needsFullSpace() const;
public:
/// is called by the framework when the dialog is opened
virtual void open();
/// is called by the framework if a button is clicked which has no accept or reject role
virtual void clicked(int);
/// is called by the framework if the dialog is accepted (Ok)
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user press the help button
virtual void helpRequested();
private:

View File

@ -86,7 +86,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -90,7 +90,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -108,7 +108,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -90,7 +90,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -99,7 +99,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -107,7 +107,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -104,7 +104,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -99,7 +99,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }

View File

@ -132,7 +132,6 @@ public:
virtual bool accept();
/// is called by the framework if the dialog is rejected (Cancel)
virtual bool reject();
/// is called by the framework if the user presses the help button
virtual bool isAllowedAlterDocument(void) const
{ return false; }