Tooltips - Revision history

Bertram: Added the right statement to create a tooltip on the 0.8 version and fixed the one used for 0.5-0.7 versions. Added a few comments about certain statement used on 0.8 only.

2014-11-24T13:28:27Z

Added the right statement to create a tooltip on the 0.8 version and fixed the one used for 0.5-0.7 versions. Added a few comments about certain statement used on 0.8 only.

Klapeto: Fixed Code to work with new CEGUI Version

2014-11-11T00:04:39Z

Fixed Code to work with new CEGUI Version

Addictgamer: Removed unnecessary lines from the example XML.

2013-11-07T17:04:03Z

Removed unnecessary lines from the example XML.

Addictgamer at 17:02, 7 November 2013

2013-11-07T17:02:14Z

Kulik at 17:00, 3 March 2011

2011-03-03T17:00:02Z

Capek: Robot: Adding Category:Uncategorised

2011-02-26T16:57:07Z

Robot: Adding Category:Uncategorised

BayerMeister: "setDefaultTooltip" is the right name of the method

2008-03-06T13:04:10Z

"setDefaultTooltip" is the right name of the method

Lindquist at 13:13, 17 April 2006

2006-04-17T13:13:57Z

Slog: /* Setting the ''Tootip'' text to display */

2006-04-12T06:53:05Z

‎Setting the ''Tootip'' text to display

Van: /* How to display the ''Tooltip'' */

2005-10-09T13:51:02Z

‎How to display the ''Tooltip''

@@ Line 17: / Line 17: @@
 <source lang="cpp">
    // Create default ToolTip item
-   CEGUI::System::getSingleton().getDefaultGUIContext().setDefaultTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
+  // On the 0.5, 0.6 and 0.7 versions only
 </source>
@@ Line 100: / Line 103: @@
      clock_t now = clock();
      CEGUI::System::getSingleton().injectTimePulse( ( now - mLastTimeInjection ) * 0.001f );
      CEGUI::System::getSingleton().getDefaultGUIContext().injectTimePulse( ( now - mLastTimeInjection ) * 0.001f );
      mLastTimeInjection = clock();
@@ Line 124: / Line 128: @@
         system.injectTimePulse( elapsed );
         system.getDefaultGUIContext().injectTimePulse( elapsed );
@@ Line 144: / Line 149: @@
    if ( CEGUI::System::getSingletonPtr() )
      CEGUI::System::getSingleton().injectTimePulse( evt.timeSinceLastFrame)
      CEGUI::System::getSingleton().getDefaultGUIContext().injectTimePulse( evt.timeSinceLastFrame );
    ...

@@ Line 17: / Line 17: @@
 <source lang="cpp">
    // Create default ToolTip item
-   CEGUI::System::getSingleton().setDefaultTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
+   CEGUI::System::getSingleton().getDefaultGUIContext().setDefaultTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
 </source>
@@ Line 81: / Line 81: @@
 '''Inject Time Pulse'''
-''CEGUI::System::injectTimePulse(float timeElapsed)''
+This is a very important piece of information that is not well documented in the current CEGUI system: ''Time Pulse Injection''. The CEGUI system, to my knowledge, does not keep track of time for you by itself - it needs help. You must inject into the CEGUI System elapsed time. If you don't do this, then your ''Tooltip'' and other time sensitive window events (like fades, etc) will not work or will not work properly. What is the ''value'' you inject? The ''value'' should be the amount of time that has elapsed since the previous injection call. Both CEGUI::System and GUI Contextes must be injected. The best place to inject a time pulse into the CEGUI is in a main loop. Here are a couple of examples of how to implement this:
-−
-This is a very important piece of information that is not well documented in the current CEGUI system: ''Time Pulse Injection''. The CEGUI system, to my knowledge, does not keep track of time for you by itself - it needs help. You must inject into the CEGUI System elapsed time. If you don't do this, then your ''Tooltip'' and other time sensitive window events (like fades, etc) will not work or will not work properly. What is the ''value'' you inject? The ''value'' should be the amount of time that has elapsed since the previous injection call. Refer to the ''CEGUI::System::injectTimePulse()''. The best place to inject a time pulse into the CEGUI system is in a main loop. Here are a couple of examples of how to implement this:
 '''Inject Time Pulse: via a MAIN Loop'''
@@ Line 100: / Line 98: @@
    if ( CEGUI::System::getSingletonPtr() )
+   {
-     CEGUI::System::getSingleton().injectTimePulse( ( clock() - mLastTimeInjection ) * 0.001f );
+    clock_t now = clock();
      mLastTimeInjection = clock();
    } // CEGUI Time pulse
    ...
 } // while
 ...
@@ Line 117: / Line 143: @@
    // and if it is, inject a time pulse
    if ( CEGUI::System::getSingletonPtr() )
-     CEGUI::System::getSingleton().injectTimePulse( evt.timeSinceLastFrame );
+     CEGUI::System::getSingleton().injectTimePulse( evt.timeSinceLastFrame)
    ...
    return true;

@@ Line 139: / Line 139: @@
          ...
          <AnimationDefinition name="FadeIn" duration="0.33" replayMode="once">
-             <Affector property="Alpha" interpolator="float">
+             ...
-                <KeyFrame position="0" sourceProperty="Alpha" />
-                <KeyFrame position="0.33" value="1" progression="linear" />
-            </Affector>
              <Affector property="Position" interpolator="UVector2" applicationMethod="relative">
                  <KeyFrame position="0" value="{{0,12},{0,0}}" />
              </Affector>
+             ...
-            <Subscription event="TooltipActive" action="Start" />
          </AnimationDefinition>
          ...

← Older revision		Revision as of 17:02, 7 November 2013
Line 126:		Line 126:

	The finer the resolution of the injection, the better your fades will look. Injecting time every one second or greater will make your ''fades'' just popup instead of ''fading'' in.		The finer the resolution of the injection, the better your fades will look. Injecting time every one second or greater will make your ''fades'' just popup instead of ''fading'' in.
		+
		+	== How to offset the ''Tooltip'' so it doesn't render under the mouse ==
		+
		+	'''Via LookNFeel animation'''
		+
		+	One way to do this is to edit your scheme's looknfeel and change the Tooltip's FadeIn animation to affect the Position property too.
		+	If the tooltip doesn't have a FadeIn animation, just add one.
		+
		+	Example:
		+	<source lang="xml">
		+	<WidgetLook name="TaharezLook/Tooltip">
		+	...
		+	<AnimationDefinition name="FadeIn" duration="0.33" replayMode="once">
		+	<Affector property="Alpha" interpolator="float">
		+	<KeyFrame position="0" sourceProperty="Alpha" />
		+	<KeyFrame position="0.33" value="1" progression="linear" />
		+	</Affector>
		+	<Affector property="Position" interpolator="UVector2" applicationMethod="relative">
		+	<KeyFrame position="0" value="{{0,12},{0,0}}" />
		+	</Affector>
		+
		+	<Subscription event="TooltipActive" action="Start" />
		+	</AnimationDefinition>
		+	...
		+	</WidgetLook>
		+	</source>
		+	This will offset the tooltip's x by 12 pixels (in my case, that's how wide my system mouse cursor is -- modify to suit your needs).

	== Conclusion ==		== Conclusion ==

@@ Line 1: / Line 1: @@
 I am not an expert but I would like to share what I have learned and gleaned about the ''Tooltip'' widget.
@@ Line 13: / Line 15: @@
 CEGUI will manage a single default, system wide ''Tooltip'' widget for you that will take care of displaying your tooltip text. You have to initialize it by calling '''CEGUI::System::setDefaultTooltip()'' one time, somehwere in your code. I would recommend calling this right after initializing the CEGUI system. Here's a sample call:
-<pre>
+<source lang="cpp">
    // Create default ToolTip item
    CEGUI::System::getSingleton().setDefaultTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
-</pre>
+</source>
 Yep, that's all there is too it.
@@ Line 28: / Line 30: @@
 You can hardcode toolip text in your code by using the ''WindowObject::setTooltipText()'' function like so:
-<pre>
+<source lang="cpp">
 CEGUI::PushButton *mPushButton = (CEGUI::PushButton *)mWinMgr->createWindow(
 (CEGUI::utf8*)"TaharezLook/PushButton", (CEGUI::utf8*)"PushButton");
 // Set other properties like size, position, etc.
 mPushButton->setTooltipText("This is a tooltip.");
-</pre>
+</source>
 '''Setting the ''Tooltip'' text in your layout (xml) file'''
 The prefered method is to set the tooltip text in your layout file and you can do it like so:
-<pre>
+<source lang="xml">
 <Window Type="TaharezLook/Editbox" Name="Login/EditBox/Password">
 	<Property Name="AbsoluteRect" Value="l:128.000000 t:0.000000 r:486.000000 b:46.000000" />
@@ Line 47: / Line 49: @@
 </Window>
-</pre>
+</source>
 '''Ensure that the Tooltip is registered in your .Scheme file'''
-<pre>
+<source lang="xml">
 <WindowSet Filename="CEGUITaharezLook">
 ....
@@ Line 56: / Line 58: @@
 ....
 </WindowSet>
-</pre>
+</source>
 '''Ensure that imageset contains graphics for the Tooltip'''
-<pre>
+<source lang="xml">
 <Imageset Name="TaharezLook" Imagefile="TaharezLook.png" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true">
 ....
@@ Line 72: / Line 75: @@
 ...
 </Imageset>
-</pre>
+</source>
 == How to display the ''Tooltip'' ==
@@ Line 84: / Line 87: @@
 '''Inject Time Pulse: via a MAIN Loop'''
-<pre>
+<source lang="cpp">
-−
 #include <time.h>
 ...
@@ Line 104: / Line 106: @@
 } // while
 ...
+</source>
-</pre>
 '''Inject Time Pulse: via an Ogre::FrameListenter'''
-<pre>
+<source lang="cpp">
 bool clsMyFrameListener::frameStarted(const Ogre::FrameEvent& evt)
@@ Line 121: / Line 122: @@
 } //frameStarted
-</pre>
+</source>
@@ Line 132: / Line 133: @@
 Some advanced notes. You can have more than one ''Tooltip'' widget. There maybe some scenerios where just one ''Tooltip'' widget won't work (like for a different look and feel from that of the default one, etc.). You can create another ''Tooltip'' widget using the standard CEGUI method for creating all the window widgets then use the ''CEGUI::Window::setToolTip()'' function to set the widget to use the desired ''Tooltip''.
-[[Category:Uncategorised]]
+[[Category:Tutorials]]

← Older revision		Revision as of 16:57, 26 February 2011
Line 131:		Line 131:

	Some advanced notes. You can have more than one ''Tooltip'' widget. There maybe some scenerios where just one ''Tooltip'' widget won't work (like for a different look and feel from that of the default one, etc.). You can create another ''Tooltip'' widget using the standard CEGUI method for creating all the window widgets then use the ''CEGUI::Window::setToolTip()'' function to set the widget to use the desired ''Tooltip''.		Some advanced notes. You can have more than one ''Tooltip'' widget. There maybe some scenerios where just one ''Tooltip'' widget won't work (like for a different look and feel from that of the default one, etc.). You can create another ''Tooltip'' widget using the standard CEGUI method for creating all the window widgets then use the ''CEGUI::Window::setToolTip()'' function to set the widget to use the desired ''Tooltip''.
		+
		+	[[Category:Uncategorised]]

@@ Line 11: / Line 11: @@
 == Creating the Default System ''Tootip'' widget ==
-CEGUI will manage a single default, system wide ''Tooltip'' widget for you that will take care of displaying your tooltip text. You have to initialize it by calling '''CEGUI::System::setTooltip()'' one time, somehwere in your code. I would recommend calling this right after initializing the CEGUI system. Here's a sample call:
+CEGUI will manage a single default, system wide ''Tooltip'' widget for you that will take care of displaying your tooltip text. You have to initialize it by calling '''CEGUI::System::setDefaultTooltip()'' one time, somehwere in your code. I would recommend calling this right after initializing the CEGUI system. Here's a sample call:
 <pre>
    // Create default ToolTip item
-   CEGUI::System::getSingleton().setTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
+   CEGUI::System::getSingleton().setDefaultTooltip( (CEGUI::utf8*)"TaharezLook/Tooltip" );
 </pre>
 Yep, that's all there is too it.
 In newer versions of CEGUI the method has been renamed to setDefaultTooltip for consistency.
 == Setting the ''Tootip'' text to display ==

← Older revision		Revision as of 13:13, 17 April 2006
Line 19:		Line 19:

	Yep, that's all there is too it.		Yep, that's all there is too it.
		+	In newer versions of CEGUI the method has been renamed to setDefaultTooltip for consistency.

← Older revision		Revision as of 06:53, 12 April 2006
Line 49:		Line 49:
	</pre>		</pre>

		+	'''Ensure that the Tooltip is registered in your .Scheme file'''
		+	<pre>
		+	<WindowSet Filename="CEGUITaharezLook">
		+	....
		+	<WindowFactory Name="TaharezLook/Tooltip" />
		+	....
		+	</WindowSet>
		+	</pre>
		+	'''Ensure that imageset contains graphics for the Tooltip'''
		+	<pre>
		+	<Imageset Name="TaharezLook" Imagefile="TaharezLook.png" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true">
		+	....
		+	<Image Name="TooltipLeftEdge" XPos="217" YPos="225" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipRightEdge" XPos="246" YPos="225" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipTopEdge" XPos="224" YPos="218" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipBottomEdge" XPos="224" YPos="248" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipTopLeft" XPos="217" YPos="218" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipTopRight" XPos="246" YPos="218" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipBottomLeft" XPos="217" YPos="248" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipBottomRight" XPos="246" YPos="248" Width="7" Height="7" XOffset="0" YOffset="0"/>
		+	<Image Name="TooltipMiddle" XPos="2" YPos="2" Width="64" Height="64" XOffset="0" YOffset="0"/>
		+	...
		+	</Imageset>
		+	</pre>

	== How to display the ''Tooltip'' ==		== How to display the ''Tooltip'' ==