mgui/tooltip.h

Go to the documentation of this file.

#ifndef  INC_MGUI_TOOLTIP_H
#define  INC_MGUI_TOOLTIP_H

#ifndef  INC_MGUI_BASE_H
#include <mgui/base.h>
#endif

#ifndef  INC_MI32_COLOR_H
#include <mi32/color.h>
#endif

#ifndef  INC_MI32_XBASE_H
#include <mi32/xbase.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
struct LPOINT2D;
class MISTRING;
namespace MGD {
   class DEVICE;
   class DEVICE_BINARY;
   }
namespace SPATMOD {
   namespace IMAGE {
      class STAGE;
      class STAGE_ARRAY;
      }
   }
#endif


namespace MGUI {

class CTRL_TOOLTIP {
   public:

      struct STYLE {
         COLOR m_BackgroundColor;
         COLOR m_BorderColor;
         COLOR m_TextColor;
         INT16 m_MarginWidth;
         INT16 m_MarginHeight;
         // Default constructor.
         STYLE ();
         };

   #ifdef X_NATIVE
      static CTRL_TOOLTIP* FindAttached (
         Widget widget
         );
   #endif

      static void HideAll ();

      CTRL_TOOLTIP ();

      virtual ~CTRL_TOOLTIP ();
      
      void AppendImage (
         const MGD::DEVICE& device,
         bool bTakeOwnership = false
         );

      void AppendImage (
         SPATMOD::IMAGE::STAGE& image
         );

      void AppendText (
         const MISTRING& text
         );

      void AppendText (
         const MISTRING& text,                     
         const SPATMOD::IMAGE::STAGE_ARRAY* Images 
         );

      void Attach (
         MGUI::CTRL& ctrl,                         
         bool DeleteOnCtrlDestroy = false          
         );

   #ifdef X_NATIVE
      void Attach (
         Widget widget,                            
         bool DeleteOnCtrlDestroy = false          
         );
   #endif

      bool CheckMotion (
         int x,
         int y,
         bool AutoHide = true
         );

   #ifdef X_NATIVE
      bool CheckMotion (
         const XEvent& event,
         bool AutoHide = true
         );
   #endif

      void Clear ();
      
      void Detach ();

      void Disable ();

      void Enable ();

      INT32 GetDelay ();

      ERRVALUE GetImages (
         SPATMOD::IMAGE::STAGE_ARRAY& Images,
         bool bTransferOwnership
         );

      const MISTRING& GetText () const;

      int GetPixelDelta () const;

      int GetPriority () const;

      const STYLE& GetStyle () const;

      void Hide ();

      bool IsDisabled () const;

      bool IsVisible () const;

      void SetAlpha (
         int alpha      
         );

      void SetDelay (
         INT32 delay                               
         );

      void SetDelegateOnShowRequest (
         DELEGATE_ONTOOLTIPREQUEST delegate        
         );

      void SetImage (
         const MGD::DEVICE& imgdev,                
         const MGD::DEVICE_BINARY* maskdev = 0,    
         const LPOINT2D* pos = 0                   
         );

      void SetPixelDelta (
         int PixelDelta                            
         );

      void SetPriority (
         int priority                              
         );

      void SetStyle (
         const STYLE& style
         );

      void SetText (
         const MISTRING& text                      
         );

      void SetText (
         const MISTRING& text,                     
         const SPATMOD::IMAGE::STAGE_ARRAY* Images 
         );

      void Show ();

   private:
      // Overridables.

      virtual bool v_HasDatatip ();

      virtual void v_OnHide ();

      virtual void v_OnShow ();

      virtual bool v_OnShowRequest (
         int x,
         int y
         );

      #ifndef GENERATING_DOXYGEN_OUTPUT

      class PRIV;
      PRIV *m_pPriv;
      friend class PRIV;

      CTRL_TOOLTIP (const CTRL_TOOLTIP&);
      CTRL_TOOLTIP& operator= (const CTRL_TOOLTIP&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}  // End namespace MGUI

#endif   // INC_MGUI_TOOLTIP_H

---