Gui::SelectionGate Class Reference

SelectionGate The selection gate allows or disallows selection of certain types. More...

#include <Selection.h>

Public Member Functions
virtual bool	allow (App::Document *, App::DocumentObject *, const char *)=0
virtual	~SelectionGate ()

Public Attributes
std::string	notAllowedReason
	notAllowedReason is a string that sets the message to be displayed in statusbar for cluing the user on why is the selection not allowed. More...

Detailed Description

SelectionGate The selection gate allows or disallows selection of certain types.

It has to be registered to the selection.

Constructor & Destructor Documentation

~SelectionGate()

virtual Gui::SelectionGate::~SelectionGate ( )

virtual

Member Function Documentation

allow()

virtual bool Gui::SelectionGate::allow ( App::Document *  , App::DocumentObject *  , const char *    )

pure virtual

Implemented in Gui::SelectionFilterGate, Gui::SelectionGatePython, Gui::SelectionFilterGatePython, Gui::SelectionGateFilterExternal, PartGui::BoxSelection::FaceSelectionGate, PartGui::DlgProjectionOnSurface::EdgeSelection, PartGui::DlgProjectionOnSurface::FaceSelection, PartGui::ShapeSelection, PartGui::DlgExtrusion::EdgeSelection, PartGui::EdgeFaceSelection, PartGui::DlgRevolution::EdgeSelection, PartGui::FaceSelection, PartGui::SweepWidget::Private::EdgeSelection, PartGui::ThicknessWidget::Private::FaceSelection, SketcherGui::GenericConstraintSelection, SketcherGui::ExtendSelection, SketcherGui::FilletSelection, SketcherGui::SplittingSelection, SketcherGui::TrimmingSelection, SurfaceGui::FillingPanel::ShapeSelection, SurfaceGui::FillingEdgePanel::ShapeSelection, SurfaceGui::FillingVertexPanel::VertexSelection, SurfaceGui::SectionsPanel::ShapeSelection, Gui::ElementColors::Private, FemGui::FemSelectionGate, PartDesignGui::ReferenceSelection, SketcherGui::CarbonCopySelection, SketcherGui::ExternalSelection, SurfaceGui::GeomFillSurface::EdgeSelection, PartDesignGui::NoDependentsSelection, and PartDesignGui::CombineSelectionFilterGates.

Referenced by Gui::SelectionSingleton::addSelection(), and Gui::SelectionSingleton::setPreselect().

Member Data Documentation

notAllowedReason

std::string Gui::SelectionGate::notAllowedReason

notAllowedReason is a string that sets the message to be displayed in statusbar for cluing the user on why is the selection not allowed.

Set this variable in allow() implementation. Enclose the literal into QT_TR_NOOP() for translatability.

Referenced by Gui::SelectionSingleton::addSelection(), Gui::SelectionGateFilterExternal::allow(), SketcherGui::CarbonCopySelection::allow(), SketcherGui::ExternalSelection::allow(), PartDesignGui::NoDependentsSelection::allow(), and Gui::SelectionSingleton::setPreselect().

---

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

• FreeCAD/src/Gui/Selection.h