FreeCAD: PathGui::TaskDlgPathCompound Class Reference

Task Dialog. More...

#include <TaskDlgPathCompound.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 rject role More...

virtual QDialogButtonBox::StandardButtons	getStandardButtons (void) const
	returns for Close and Help button More...

virtual void	helpRequested ()
	is called by the framework if the user press 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...

	TaskDlgPathCompound (PathGui::ViewProviderPathCompound *)

	~TaskDlgPathCompound ()

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
PathGui::ViewProviderPathCompound *	CompoundView

TaskWidgetPathCompound *	parameter

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

Task Dialog.

Constructor & Destructor Documentation

◆ TaskDlgPathCompound()

TaskDlgPathCompound::TaskDlgPathCompound ( PathGui::ViewProviderPathCompound * obj )

References CompoundView, Gui::TaskView::TaskDialog::Content, and parameter.

◆ ~TaskDlgPathCompound()

TaskDlgPathCompound::~TaskDlgPathCompound ( )

Member Function Documentation

◆ accept()

bool TaskDlgPathCompound::accept ( void )

virtual

is called by the framework if the dialog is accepted (Ok)

Reimplemented from Gui::TaskView::TaskDialog.

References CompoundView, App::DocumentObject::getDocument(), PathGui::TaskWidgetPathCompound::getList(), App::Document::getObject(), Gui::ViewProviderDocumentObject::getObject(), Path::FeatureCompound::Group, Gui::Command::Gui, parameter, and App::PropertyLinkList::setValues().

Referenced by femexamples.examplesgui.FemExamples::clicked(), femexamples.examplesgui.FemExamples::double_clicked(), ArchComponent.ComponentTaskPanel::editObject(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary::toolEdit().

◆ clicked()

void TaskDlgPathCompound::clicked ( int button )

virtual

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

Reimplemented from Gui::TaskView::TaskDialog.

◆ getStandardButtons()

virtual QDialogButtonBox::StandardButtons PathGui::TaskDlgPathCompound::getStandardButtons ( void ) const

virtual

returns for Close and Help button

Reimplemented from Gui::TaskView::TaskDialog.

◆ helpRequested()

void TaskDlgPathCompound::helpRequested ( )

virtual

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

Reimplemented from Gui::TaskView::TaskDialog.

◆ open()

void TaskDlgPathCompound::open ( )

virtual

is called the TaskView when the dialog is opened

Reimplemented from Gui::TaskView::TaskDialog.

◆ reject()

bool TaskDlgPathCompound::reject ( void )

virtual

is called by the framework if the dialog is rejected (Cancel)

Reimplemented from Gui::TaskView::TaskDialog.

References Gui::Command::Gui.

Referenced by draftguitools.gui_hatch.Draft_Hatch_TaskPanel::accept(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelCmd::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanelEdit::accept(), drafttaskpanels.task_shapestring.ShapeStringTaskPanel::action(), femexamples.examplesgui.FemExamples::clicked(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary::toolEdit().

Member Data Documentation

◆ CompoundView

PathGui::ViewProviderPathCompound* PathGui::TaskDlgPathCompound::CompoundView

protected

Referenced by accept(), and TaskDlgPathCompound().

◆ parameter

TaskWidgetPathCompound* PathGui::TaskDlgPathCompound::parameter

protected

Referenced by accept(), Mod.Test.Document.DocumentObserverCases.Observer::slotAbortTransaction(), Mod.Test.Document.DocumentObserverCases.Observer::slotActivateDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotActivateDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotAddedDynamicExtension(), Mod.Test.Document.DocumentObserverCases.Observer::slotAppendDynamicProperty(), Mod.Test.Document.DocumentObserverCases.Observer::slotBeforeAddingDynamicExtension(), Mod.Test.Document.DocumentObserverCases.Observer::slotBeforeChangeDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotBeforeChangeObject(), Mod.Test.Document.DocumentObserverCases.Observer::slotChangedDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotChangedObject(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotChangedObject(), Mod.Test.Document.DocumentObserverCases.Observer::slotChangePropertyEditor(), Mod.Test.Document.DocumentObserverCases.Observer::slotCommitTransaction(), Mod.Test.Document.DocumentObserverCases.Observer::slotCreatedDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotCreatedDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotCreatedObject(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotCreatedObject(), Mod.Test.Document.DocumentObserverCases.Observer::slotDeletedDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotDeletedDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotDeletedObject(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotDeletedObject(), Mod.Test.Document.DocumentObserverCases.Observer::slotFinishSaveDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotInEdit(), Mod.Test.Document.DocumentObserverCases.Observer::slotOpenTransaction(), Mod.Test.Document.DocumentObserverCases.Observer::slotRecomputedDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotRecomputedObject(), Mod.Test.Document.DocumentObserverCases.Observer::slotRedoDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotRelabelDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotRelabelDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotRemoveDynamicProperty(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotRenameDocument(), Mod.Test.Document.DocumentObserverCases.GuiObserver::slotResetEdit(), Mod.Test.Document.DocumentObserverCases.Observer::slotStartSaveDocument(), Mod.Test.Document.DocumentObserverCases.Observer::slotUndoDocument(), and TaskDlgPathCompound().

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

FreeCAD/src/Mod/Path/Gui/TaskDlgPathCompound.h
FreeCAD/src/Mod/Path/Gui/TaskDlgPathCompound.cpp