All Frameworks Class Hierarchy This Framework Previous Next Indexes
InteractiveInterfaces Interface CATIIniDocumentFiltersDefinition
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIIniDocumentFiltersDefinition
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIIniDocumentFiltersDefinition
Interface for layers filter management.
Role:
This interface is implemented on all V5 documents.
To query or modify the filters do not implement this interface, just query the document on this interface.
A filter is managed by a pointer to the CATIIniLayersFilter interface. The filters you will manage with this interface depend on the context.
- If the ui-active document is edited in an assembly (for example a CATPart in a CATProduct), the filters managed by this interface can be:
- The filters saved in the document (only applied to this document)
if the setting defined in Tools/Options/General/Display/Layer Filter is set to "Current filter of the document"
- The filters saved in the CATSettings (applied to any assembly opened in the session)
if the setting defined in Tools/Options/General/Display/Layer Filter is set to "Current filter on all documents"
- If the ui-active document is a CATProduct, the filters managed are those of the CATSettings.
- If the current document is edited outside of an asembly (it's a CATPart, a CATDrawing, etc...), the filters managed are those of the document.
Method Index
- o
Add(CATIIniLayersFilter*&,CATUnicodeString,CATUnicodeString,FilterContentCheckMode,CATBoolean)
- Creates a filter.
- o
Find(CATUnicodeString,CATIIniLayersFilter*&)
- Retrieves a filter by its name.
- o
GetCurrent(CATIIniLayersFilter*&)
- Retrieves the current filter.
- o
GetList(CATListPtrCATIIniLayersFilter*&)
- Retrieves the layers filter list.
- o
Remove(CATIIniLayersFilter*&)
- Removes a filter.
- o
SetCurrent(CATIIniLayersFilter*&)
- Changes the current filter.
Enumerated Type Index
- o
FilterContentCheckMode
- Check mode for layer filter description.
Methods
o Add
-
Creates a filter.
Role:
Creates a new filter and adds it to the filters list.
- Parameters:
-
- opFilter
- The created filter.
- If no filter with same name or same content already exists, a new filter is created, its pointer is returned and the return code is S_OK.
- If a filter with same name already exists, its description is changed, its pointer is returned and the return code is S_OK.
- If a filter with same description already exists, its name is changed, its pointer is returned and the return code is S_OK.
- If a filter with same description AND same name already exists, its pointer is returned and the return code is S_FALSE.
- iFilterName
- The name of the filter.
- iFilterContent
- The filter description.
- iCheckMode
- The filter description check mode.
- iDisplayError
- The filter check error display mode.
- FALSE: No display (Default Value)
- TRUE: Display a error within a dialog box
- Returns:
-
Legal values:
- S_OK if the filter was correctly created
- S_FALSE if this filter already exists
- E_FAIL if the filter could not be created
o Find
-
Retrieves a filter by its name.
Role:
- Parameters:
-
- iName
- The filter name.
- opFilter
- The filter found.
- Returns:
-
Legal values:
- S_OK if the filter was found
- E_FAIL if the filter does not exist
o GetCurrent
-
Retrieves the current filter.
Role:
- Parameters:
-
- opFilter
- The filter set as current.
- Returns:
-
Legal values:
- S_OK if the current filter was found
- E_FAIL if no current filter was found
o GetList
public virtual HRESULT GetList( | CATListPtrCATIIniLayersFilter*& | opList) = 0 |
-
Retrieves the layers filter list.
Role:
- Parameters:
-
- opList
- The list of filters.
- Returns:
-
Legal values:
- S_OK if a filters list was found
- E_FAIL no filters list was found
o Remove
-
Removes a filter.
Role:
Deletes a filter and removes it from the filters list.
- Parameters:
-
- ipFilter
- The filter to delete.
- Returns:
-
Legal values:
- S_OK if the filter was correctly removed
- E_FAIL if the filter does not exist
o SetCurrent
-
Changes the current filter.
Role:
Sets a filter as the current one. This recomputes the visualization.
- Parameters:
-
- ipFilter
- The filter to set as current.
- Returns:
-
Legal values:
- S_OK if the current filter was changed
- E_FAIL if no current filter was found
Enumerated Types
o FilterContentCheckMode
-
enum FilterContentCheckMode {
NoCheck,
CheckNLS,
CheckAndConvert
}
Check mode for layer filter description.
Role:
Lists the different check modes that can be applied to a layer filter description.
- Parameters:
-
- NoCheck
- No check at all
- CheckNLS
- Check NLS contents
- CheckAndConvert
- Check and convert from trans-format to NLS contents
This object is included in the file: CATIIniDocumentFiltersDefinition.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces