Gui::SelectionFilterGate Class Reference

Filter object for the SelectionSengleton This object is a link between the selection filter class and the selection singleton. More...

#include <SelectionFilter.h>

Public Member Functions
virtual bool	allow (App::Document *, App::DocumentObject *, const char *)
	SelectionFilterGate (const char *filter)
	construct with the filter string More...
	SelectionFilterGate (SelectionFilter *filter)
	~SelectionFilterGate ()
Public Member Functions inherited from Gui::SelectionGate
virtual bool	allow (App::Document *, App::DocumentObject *, const char *)=0
virtual	~SelectionGate ()

Protected Member Functions
	SelectionFilterGate ()

Static Protected Member Functions
static SelectionFilter *	nullPointer ()
static const char *	nullString ()

Protected Attributes
SelectionFilter *	Filter

Additional Inherited Members
Public Attributes inherited from Gui::SelectionGate
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

Filter object for the SelectionSengleton This object is a link between the selection filter class and the selection singleton.

Created with a filter string and registered in the selection it will only allow the described object types to be selected.

See also

SelectionFilter

SelectionSingleton

Constructor & Destructor Documentation

SelectionFilterGate() [1/3]

SelectionFilterGate::SelectionFilterGate

(

const char *

filter

)

construct with the filter string

References Filter.

SelectionFilterGate() [2/3]

SelectionFilterGate::SelectionFilterGate

(

SelectionFilter *

filter

)

References Filter.

~SelectionFilterGate()

SelectionFilterGate::~SelectionFilterGate

(

)

References Filter.

SelectionFilterGate() [3/3]

SelectionFilterGate::SelectionFilterGate ( )

protected

References Filter.

Member Function Documentation

allow()

bool SelectionFilterGate::allow ( App::Document *  , App::DocumentObject *  pObj, const char *  sSubName  )

virtual

Implements Gui::SelectionGate.

Reimplemented in 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, FemGui::FemSelectionGate, PartDesignGui::ReferenceSelection, SketcherGui::CarbonCopySelection, SketcherGui::ExternalSelection, SurfaceGui::GeomFillSurface::EdgeSelection, PartDesignGui::NoDependentsSelection, and PartDesignGui::CombineSelectionFilterGates.

References Filter, and Gui::SelectionFilter::test().

nullPointer()

static SelectionFilter * Gui::SelectionFilterGate::nullPointer ( )

staticprotected

nullString()

static const char * Gui::SelectionFilterGate::nullString ( )

staticprotected

Member Data Documentation

Filter

SelectionFilter* Gui::SelectionFilterGate::Filter

protected

Referenced by allow(), SelectionFilterGate(), and ~SelectionFilterGate().

---

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

• FreeCAD/src/Gui/SelectionFilter.h
• FreeCAD/src/Gui/SelectionFilter.cpp