CATPLMFastenerUseItf CATFstFilterCustoDialogObj
Usage: you must use this class as is. You should never derive it.
public class CATFstFilterCustoDialogObj
CATFstFilterCustoDialogObj contains all required information to build properly the filter.
Role: This is a class which represents a custo Dialog object, which is to be added in the ‘Filter Criteria’ panel.
Customer is supposed to create an Object of this class (one object corresponding to each custo dialog objects), append it in
a List and return that list in the method GetFilterCustoDialogObj. Depending upon the ‘type’, corresponding a dialog object is
created and integrated in the panel.
Constructor and Destructor Index
- o
CATFstFilterCustoDialogObj()
- Constructs an empty CATFstFilterCustoDialogObj.
- o
CATFstFilterCustoDialogObj(CATString&,CATString&,CATString&,CATFstFilterProcessor*,CATFstValidProcessor*)
- Constructs a Filter custo dialog object.
- o
~CATFstFilterCustoDialogObj()
-
Method Index
- o
GetCATNLS_Name()
- Retrieves the name of the CATNLS file.
- o
GetFilterName()
- Retrieves the filter's name.
- o
GetFilterProcessor()
- Retrieves the filter processor.
- o
GetFilterViewType()
- Retrieves the filter's type.
- o
GetValidProcessor()
- Retrieves the validation processor.
- o
SetFilterName(CATString&)
- Sets filter's name.
Constructor and Destructor
o CATFstFilterCustoDialogObj
| public CATFstFilterCustoDialogObj( | ) |
-
Constructs an empty CATFstFilterCustoDialogObj.
o CATFstFilterCustoDialogObj
| public CATFstFilterCustoDialogObj( | | iFilterName, |
| | iFilterViewType, |
| | iCATNLS_Name, |
| | ipFilterProcessor, |
| | ipValidProcessor) |
-
Constructs a Filter custo dialog object.
- Parameters:
-
- iFilterName
- [in] The filter name to be created.
This filter name is later used to recover the data coresponding at this filter inside the CATNLS file
- iFilterViewType
- [in] The filter view type.
Legal values:
- TextBox
- if the view filter type is a text box.
- iCATNLS_Name
- [in] The CATNLS file's name.
All filters corresponding texts to be shown inside the ‘Filter Criteria’ panel appear inside this CATNLS file
- ipFilterProcessor
- [in] The filter processor
- ipValidProcessor
- [in] The validation processor of the filter's input
o ~CATFstFilterCustoDialogObj
| public virtual ~CATFstFilterCustoDialogObj( | ) |
-
Methods
o GetCATNLS_Name
-
Retrieves the name of the CATNLS file.
Role: This method retrieves the name of the CATNLS file.
- Returns:
- The name of the CATNLS file.
o GetFilterName
-
Retrieves the filter's name.
Role: This method retrieves filter's name.
- Returns:
- The filter's name.
o GetFilterProcessor
| public GetFilterProcessor( | ) |
-
Retrieves the filter processor.
Role: This method retrieves the filter processor.
- Returns:
- The filter processor
o GetFilterViewType
| public GetFilterViewType( | ) |
-
Retrieves the filter's type.
Role: This method retrieves filter's type.
- Returns:
- The filter's type.
o GetValidProcessor
| public GetValidProcessor( | ) |
-
Retrieves the validation processor.
Role: This method retrieves the validation processor.
- Returns:
- The validation processor
o SetFilterName
| public SetFilterName( | | iFilterName) |
-
Sets filter's name.
Role: This method sets filter's name.
- Parameters:
-
- iFilterName
- [in] The filter's name. This filter name is later used to recover the data coresponding at this filter inside the CATNLS file.
This object is included in the file: CATFstFilterCustoDialogObj.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.