All Frameworks  Class Hierarchy  This Framework  Indexes   

CATIAApplicationFrame Interface 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 GetDeepSearchActivationInfo(CATSettingInfo*)
Retrieves information about the Deep Search Activation setting parameter.
o GetDeepSearchActivation(CATBoolean&)
Retrieves the Deep Search Activation attribute.
o GetDefaultPowerInputContextPriorityInfo(CATSettingInfo*)
Retrieves information about the Default Power Input Context Priority setting parameter.
o GetDefaultPowerInputContextPriority(CATBoolean&)
Retrieves the Default Power Input Context Priority attribute.
o GetDefaultPowerInputContextScopeInfo(CATSettingInfo*)
Retrieves information about the Default Power Input Context Scope setting parameter.
o GetDefaultPowerInputContextScope(CATSearchContextScope&)
Retrieves the Default Power Input Context Scope attribute.
o GetDefaultPowerInputPrefixInfo(CATSettingInfo*)
Retrieves information about the Default Power Input Prefix setting parameter.
o GetDefaultPowerInputPrefix(CATUnicodeString&)
Retrieves the Default Power Input Prefix attribute.
o GetMaxDisplayedResultsInfo(CATSettingInfo*)
Retrieves information about the Max Displayed Results setting parameter.
o GetMaxDisplayedResults(unsigned int&)
Retrieves the Max Displayed Results attribute.
o GetMaxPreHighlightedElementsInfo(CATSettingInfo*)
Retrieves information about the Max Pre-Highlighted Elements setting parameter.
o GetMaxPreHighlightedElements(unsigned int&)
Retrieves the Max Pre-Highlighted Elements attribute.
o SetDeepSearchActivationLock(unsigned char)
Locks or unlocks the Deep Search Activation setting parameter.
o SetDeepSearchActivation(CATBoolean&)
Sets the Deep Search Activation attribute.
o SetDefaultPowerInputContextPriorityLock(unsigned char)
Locks or unlocks the Default Power Input Context Priority setting parameter.
o SetDefaultPowerInputContextPriority(CATBoolean&)
Sets the Default Power Input Context Priority attribute.
o SetDefaultPowerInputContextScopeLock(unsigned char)
Locks or unlocks the Default Power Input Context Scope setting parameter.
o SetDefaultPowerInputContextScope(CATSearchContextScope&)
Sets the Default Power Input Context Scope attribute.
o SetDefaultPowerInputPrefixLock(unsigned char)
Locks or unlocks the Default Power Input Prefix setting parameter.
o SetDefaultPowerInputPrefix(CATUnicodeString&)
Sets the Default Power Input Prefix attribute.
o SetMaxDisplayedResultsLock(unsigned char)
Locks or unlocks the Max Displayed Results setting parameter.
o SetMaxDisplayedResults(unsigned int&)
Sets the Max Displayed Results attribute.
o SetMaxPreHighlightedElementsLock(unsigned char)
Locks or unlocks the Max Pre-Highlighted Elements setting parameter.
o SetMaxPreHighlightedElements(unsigned int&)
Sets the Max Pre-Highlighted Elements attribute.

Methods


o GetDeepSearchActivationInfo
public virtual GetDeepSearchActivationInfo( oInfo)
Retrieves information about the Deep Search Activation setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDeepSearchActivation
public virtual GetDeepSearchActivation( oActivation)
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 GetDefaultPowerInputContextPriorityInfo
public virtual GetDefaultPowerInputContextPriorityInfo( oInfo)
Retrieves information about the Default Power Input Context Priority setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDefaultPowerInputContextPriority
public virtual GetDefaultPowerInputContextPriority( oPriority)
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 GetDefaultPowerInputContextScopeInfo
public virtual GetDefaultPowerInputContextScopeInfo( oInfo)
Retrieves information about the Default Power Input Context Scope setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDefaultPowerInputContextScope
public virtual GetDefaultPowerInputContextScope( oScope)
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 GetDefaultPowerInputPrefixInfo
public virtual GetDefaultPowerInputPrefixInfo( oInfo)
Retrieves information about the Default Power Input Prefix setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetDefaultPowerInputPrefix
public virtual GetDefaultPowerInputPrefix( oPrefix)
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 GetMaxDisplayedResultsInfo
public virtual GetMaxDisplayedResultsInfo( oInfo)
Retrieves information about the Max Displayed Results setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetMaxDisplayedResults
public virtual GetMaxDisplayedResults( oValue)
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 GetMaxPreHighlightedElementsInfo
public virtual GetMaxPreHighlightedElementsInfo( oInfo)
Retrieves information about the Max Pre-Highlighted Elements setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetMaxPreHighlightedElements
public virtual GetMaxPreHighlightedElements( oValue)
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 SetDeepSearchActivationLock
public virtual SetDeepSearchActivationLock( iLocked)
Locks or unlocks the Deep Search Activation setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDeepSearchActivation
public virtual SetDeepSearchActivation( const iActivation)
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 SetDefaultPowerInputContextPriorityLock
public virtual SetDefaultPowerInputContextPriorityLock( iLocked)
Locks or unlocks the Default Power Input Context Priority setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDefaultPowerInputContextPriority
public virtual SetDefaultPowerInputContextPriority( const iPriority)
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 SetDefaultPowerInputContextScopeLock
public virtual SetDefaultPowerInputContextScopeLock( iLocked)
Locks or unlocks the Default Power Input Context Scope setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDefaultPowerInputContextScope
public virtual SetDefaultPowerInputContextScope( const iScope)
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 SetDefaultPowerInputPrefixLock
public virtual SetDefaultPowerInputPrefixLock( iLocked)
Locks or unlocks the Default Power Input Prefix setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetDefaultPowerInputPrefix
public virtual SetDefaultPowerInputPrefix( const iPrefix)
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 SetMaxDisplayedResultsLock
public virtual SetMaxDisplayedResultsLock( iLocked)
Locks or unlocks the Max Displayed Results setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetMaxDisplayedResults
public virtual SetMaxDisplayedResults( const iValue)
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 SetMaxPreHighlightedElementsLock
public virtual SetMaxPreHighlightedElementsLock( iLocked)
Locks or unlocks the Max Pre-Highlighted Elements setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetMaxPreHighlightedElements
public virtual SetMaxPreHighlightedElements( const iValue)
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

This object is included in the file: CATICafSearchSettingAtt.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame

Copyright © 2003, Dassault Systèmes. All rights reserved.