VisualizationController CATRepShortHelp
Usage: you must use this class as is. You should never derive it.
public class CATRepShortHelp
Class to add a short message to the representation.
Role: This message is usually used to give a short help
about the representation.
When a representation is preactivated (see also ) CATRepShortHelp will send a SHORTHELP_PREACTIVATED event and
the callback method will be activated.
In this callback method an application can display
a text within a balloon using
method.
Constructor and Destructor Index
- o
CATRepShortHelp()
- Constructs a CATRepShortHelp instance.
- o
~CATRepShortHelp()
-
Method Index
- o
HideShortHelp()
- Delete the short help text.
- o
ShowShortHelp(CATUnicodeString)
- Shows a short help text.
Constructor and Destructor
o CATRepShortHelp
-
Constructs a CATRepShortHelp instance.
A default instance of the CATRepShortHelp can be obtained
from CATViewer::SetShortHelpState method.
o ~CATRepShortHelp
| public virtual ~CATRepShortHelp( | ) |
-
Methods
o HideShortHelp
-
Delete the short help text.
o ShowShortHelp
| public ShowShortHelp( | | iText) |
-
Shows a short help text.
- Parameters:
-
- iText
- The text to display in a balloon under the mouse cursor.
This object is included in the file: CATRepShortHelp.h
If needed, your Imakefile.mk should include the module: CATVisController
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.