InteractiveInterfaces Interface CATIIniSearchSVisibilityCriterion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIIniSearchSVisibilityCriterion
Interface to define a visibility-based criterion.
Role: This interface enables the complete definition of
a search criterion on the visibility graphic attribute.
The objects found will match the visibility and operating
sign, as specified in the method.
Objects that do not have this graphic attribute are excluded
from the search results, whatever is the chosen operating sign.
Method Index
- o
GetParameters(CATIIniSearchSVisibilityCriterion::CATCafSearchSVisibilityAttribut&,CATIniSearchEnumeration::Comparison&)
- Gets the visibility parameter using an enumeration value.
- o
SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison)
- Sets the visibility parameter using a character string.
- o
SetParameters(CATIIniSearchSVisibilityCriterion::CATCafSearchSVisibilityAttribut,CATIniSearchEnumeration::Comparison)
- Sets the visibility parameter using an enumeration value.
Enumerated Type Index
- o
CATCafSearchSVisibilityAttribut
- Enumeration of available visibility types.
Methods
o GetParameters
| public virtual GetParameters( | | oVisibilityString, |
| | oOperatingSign) |
-
Gets the visibility parameter using an enumeration value.
Role: This method gets the visibility parameter
thanks to an enumeration representing the visibility status.
- Parameters:
-
- oVisibilityString
- The enumeration representing the visibility status.
- oOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- Returns:
- E_FAIL if the criterion is not correctly retrieved.
S_OK otherwise.
o SetParameters
| public virtual SetParameters( | const | iVisibilityString, |
| | iOperatingSign) |
-
Sets the visibility parameter using a character string.
Role: This method sets the visibility parameter
thanks to a CATUnicodeString representing the visibility
status.
- Parameters:
-
- iVisibilityString
- The string representing the visibility status. The case used is not
important.
It can either be the transformat values visible or
hidden
or, the user can use a language specific name (displayed in
the Edit/Search user interface). However the criterion would then
only work in an application session using this language.
- iOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- Returns:
- E_FAIL if the criterion is not correctly set up.
S_OK otherwise.
o SetParameters
| public virtual SetParameters( | | iVisible, |
| | iOperatingSign) |
-
Sets the visibility parameter using an enumeration value.
Role: This method sets the visibility parameter
thanks to an enumeration representing the visibility status.
- Parameters:
-
- iVisible
- The enumeration representing the visibility status.
- iOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- Returns:
- E_FAIL if the criterion is not correctly set up.
S_OK otherwise.
Enumerated Types
o CATCafSearchSVisibilityAttribut
-
enum CATCafSearchSVisibilityAttribut {
CATVisibleAttr,
CATInvisibleAttr,
CATShownAttr,
CATHiddenAttr
}
Enumeration of available visibility types.
The following types are allowed:
- Parameters:
-
- CATVisibleAttr
- for objects that have the visible attribute.
- CATInvisibleAttr
- for objects that have the invisible/hidden attribute.
- CATShownAttr
- for objects that are visible.
- CATHiddenAttr
- for objects that are invisible/hidden.
This object is included in the file: CATIIniSearchSVisibilityCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.