HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
STY_ResultsFilter Class Reference

#include <STY_ResultsFilter.h>

+ Inheritance diagram for STY_ResultsFilter:

Public Member Functions

 STY_ResultsFilter (const char *category_mask=nullptr)
 
virtual ~STY_ResultsFilter ()
 
virtual bool acceptsCategory (const UT_StringHolder &category_name) const
 Returns true if the filter allows the overrides from the given category. More...
 
virtual bool acceptsFurtherOverrides (const STY_Style &style) const
 

Additional Inherited Members

- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyableoperator= (const UT_NonCopyable &)=delete
 

Detailed Description

Filter that decides which results should be retrieved with a call to getResults() in a styler. Since virtually all calls to getResults() will want results from a specific category, the constructor takes category mask for convenience. Any custom filtering can be done by deriving from this class.

Definition at line 25 of file STY_ResultsFilter.h.

Constructor & Destructor Documentation

STY_ResultsFilter::STY_ResultsFilter ( const char *  category_mask = nullptr)

Constructor, which for convenience takes a mask for accepted override categories. The argument can be NULL for all categories.

virtual STY_ResultsFilter::~STY_ResultsFilter ( )
virtual

Member Function Documentation

virtual bool STY_ResultsFilter::acceptsCategory ( const UT_StringHolder category_name) const
virtual

Returns true if the filter allows the overrides from the given category.

virtual bool STY_ResultsFilter::acceptsFurtherOverrides ( const STY_Style style) const
virtual

Returns true if the filter allows the overrides from style sheet entries of lower precedence level than the given style entry. Usually the overrides from all matching entries are allowed, but sometimes an entery may block any further overrides, eg, if an style contains 'material' override, andy lower level overrides for 'materialParameters' need to be disregarded, since they were intended for the old material.

Reimplemented in STY_MaterialResultsFilter.


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