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 SelectionFilternullPointer ()
 
static const char * nullString ()
 

Protected Attributes

SelectionFilterFilter
 

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()

◆ nullPointer()

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

◆ nullString()

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

Member Data Documentation

◆ Filter

SelectionFilter* Gui::SelectionFilterGate::Filter
protected

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