All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATIAApplicationFrame Interface CATICafSearchSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICafSearchSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICafSearchSettingAtt
Interface to the Search setting controller.
Role: The Search setting controller is dedicated to manage
the setting parameters used with the Search dialog box or the Power Input.
Method Index
- o
GetDeepSearchActivation(CATBoolean&)
- Retrieves the Deep Search Activation attribute.
- o
GetDeepSearchActivationInfo(CATSettingInfo*)
- Retrieves information about the Deep Search Activation setting parameter.
- o
GetDefaultPowerInputContextPriority(CATBoolean&)
- Retrieves the Default Power Input Context Priority attribute.
- o
GetDefaultPowerInputContextPriorityInfo(CATSettingInfo*)
- Retrieves information about the Default Power Input Context Priority setting parameter.
- o
GetDefaultPowerInputContextScope(CATSearchContextScope&)
- Retrieves the Default Power Input Context Scope attribute.
- o
GetDefaultPowerInputContextScopeInfo(CATSettingInfo*)
- Retrieves information about the Default Power Input Context Scope setting parameter.
- o
GetDefaultPowerInputPrefix(CATUnicodeString&)
- Retrieves the Default Power Input Prefix attribute.
- o
GetDefaultPowerInputPrefixInfo(CATSettingInfo*)
- Retrieves information about the Default Power Input Prefix setting parameter.
- o
GetMaxDisplayedResults(unsigned int&)
- Retrieves the Max Displayed Results attribute.
- o
GetMaxDisplayedResultsInfo(CATSettingInfo*)
- Retrieves information about the Max Displayed Results setting parameter.
- o
GetMaxPreHighlightedElements(unsigned int&)
- Retrieves the Max Pre-Highlighted Elements attribute.
- o
GetMaxPreHighlightedElementsInfo(CATSettingInfo*)
- Retrieves information about the Max Pre-Highlighted Elements setting parameter.
- o
SetDeepSearchActivation(CATBoolean&)
- Sets the Deep Search Activation attribute.
- o
SetDeepSearchActivationLock(unsigned char)
- Locks or unlocks the Deep Search Activation setting parameter.
- o
SetDefaultPowerInputContextPriority(CATBoolean&)
- Sets the Default Power Input Context Priority attribute.
- o
SetDefaultPowerInputContextPriorityLock(unsigned char)
- Locks or unlocks the Default Power Input Context Priority setting parameter.
- o
SetDefaultPowerInputContextScope(CATSearchContextScope&)
- Sets the Default Power Input Context Scope attribute.
- o
SetDefaultPowerInputContextScopeLock(unsigned char)
- Locks or unlocks the Default Power Input Context Scope setting parameter.
- o
SetDefaultPowerInputPrefix(CATUnicodeString&)
- Sets the Default Power Input Prefix attribute.
- o
SetDefaultPowerInputPrefixLock(unsigned char)
- Locks or unlocks the Default Power Input Prefix setting parameter.
- o
SetMaxDisplayedResults(unsigned int&)
- Sets the Max Displayed Results attribute.
- o
SetMaxDisplayedResultsLock(unsigned char)
- Locks or unlocks the Max Displayed Results setting parameter.
- o
SetMaxPreHighlightedElements(unsigned int&)
- Sets the Max Pre-Highlighted Elements attribute.
- o
SetMaxPreHighlightedElementsLock(unsigned char)
- Locks or unlocks the Max Pre-Highlighted Elements setting parameter.
Methods
o GetDeepSearchActivation
-
Retrieves the Deep Search Activation attribute.
Role: The Deep Search Activation attribute manages the Deep Search option
available in the Search dialog box used to determine whether documents in visualization
mode must be transiently loaded during a search query.
- Parameters:
-
- oActivation
- [out] The Deep Search Activation attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetDeepSearchActivationInfo
-
Retrieves information about the Deep Search Activation setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDefaultPowerInputContextPriority
-
Retrieves the Default Power Input Context Priority attribute.
Role: The Default Power Input Context Priority attribute manages whether the default
context scope must override the context scope stored in a favorite query.
- Parameters:
-
- oPriority
- [out] The Default Power Input Context Priority attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetDefaultPowerInputContextPriorityInfo
-
Retrieves information about the Default Power Input Context Priority setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDefaultPowerInputContextScope
public virtual HRESULT GetDefaultPowerInputContextScope( | CATSearchContextScope& | oScope) = 0 |
-
Retrieves the Default Power Input Context Scope attribute.
Role: The Default Power Input Context Scope attribute manages the default context scope
to be used when none is typed in the Power Input field
- Parameters:
-
- oScope
- [out] The Default Power Input Context Scope attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetDefaultPowerInputContextScopeInfo
-
Retrieves information about the Default Power Input Context Scope setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDefaultPowerInputPrefix
-
Retrieves the Default Power Input Prefix attribute.
Role: The Default Power Input Prefix attribute manages the default prefix
to be used when none is typed in the Power Input field
- Parameters:
-
- oPrefix
- [out] The Default Power Input Prefix attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetDefaultPowerInputPrefixInfo
-
Retrieves information about the Default Power Input Prefix setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMaxDisplayedResults
public virtual HRESULT GetMaxDisplayedResults( | unsigned int& | oValue) = 0 |
-
Retrieves the Max Displayed Results attribute.
Role: The Max Displayed Results attribute indicates the maximum number of elements
that can be displayed in the Search results page. Displaying too many lines can stick more
or less the results list so it is recommended to limit this number.
- Parameters:
-
- oValue
- [out] The Max Displayed Results attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetMaxDisplayedResultsInfo
-
Retrieves information about the Max Displayed Results setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMaxPreHighlightedElements
public virtual HRESULT GetMaxPreHighlightedElements( | unsigned int& | oValue) = 0 |
-
Retrieves the Max Pre-Highlighted Elements attribute.
Role: The Max Pre-Highlighted Elements attribute indicates the maximum number of elements
that can be displayed in the Search results page. Displaying too many elements can stick the session
so it is strongly recommended to limit this number.
- Parameters:
-
- oValue
- [out] The Max Pre-Highlighted Elements attribute value
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o GetMaxPreHighlightedElementsInfo
-
Retrieves information about the Max Pre-Highlighted Elements setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDeepSearchActivation
-
Sets the Deep Search Activation attribute.
- Parameters:
-
- iActivation
- [in] The Deep Search Activation attribute value.
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetDeepSearchActivationLock
public virtual HRESULT SetDeepSearchActivationLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Deep Search Activation setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDefaultPowerInputContextPriority
public virtual HRESULT SetDefaultPowerInputContextPriority( | const CATBoolean& | iPriority) = 0 |
-
Sets the Default Power Input Context Priority attribute.
- Parameters:
-
- iPriority
- [in] The Default Power Input Context Priority attribute value.
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetDefaultPowerInputContextPriorityLock
public virtual HRESULT SetDefaultPowerInputContextPriorityLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Default Power Input Context Priority setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDefaultPowerInputContextScope
public virtual HRESULT SetDefaultPowerInputContextScope( | const CATSearchContextScope& | iScope) = 0 |
-
Sets the Default Power Input Context Scope attribute.
- Parameters:
-
- iScope
- [in] The Default Power Input Context Scope attribute value.
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetDefaultPowerInputContextScopeLock
public virtual HRESULT SetDefaultPowerInputContextScopeLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Default Power Input Context Scope setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDefaultPowerInputPrefix
-
Sets the Default Power Input Prefix attribute.
- Parameters:
-
- iPrefix
- [in] The Default Power Input Prefix attribute value.
Legal values: string containing the prefix ("c:", "f:", "t:", ...)
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetDefaultPowerInputPrefixLock
public virtual HRESULT SetDefaultPowerInputPrefixLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Default Power Input Prefix setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMaxDisplayedResults
public virtual HRESULT SetMaxDisplayedResults( | const unsigned int& | iValue) = 0 |
-
Sets the Max Displayed Results attribute.
- Parameters:
-
- iValue
- [in] The Max Displayed Results attribute value.
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetMaxDisplayedResultsLock
public virtual HRESULT SetMaxDisplayedResultsLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Max Displayed Results setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMaxPreHighlightedElements
public virtual HRESULT SetMaxPreHighlightedElements( | const unsigned int& | iValue) = 0 |
-
Sets the Max Pre-Highlighted Elements attribute.
- Parameters:
-
- iValue
- [in] The Max Pre-Highlighted Elements attribute value.
- Returns:
- Legal values:
S_OK: on Success
E_FAIL: on Failure
o SetMaxPreHighlightedElementsLock
public virtual HRESULT SetMaxPreHighlightedElementsLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the Max Pre-Highlighted Elements setting parameter.
Refer to
CATSysSettingController for a detailed description.
This object is included in the file: CATICafSearchSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame