struct CCL::ITooltipPopup

Overview

#include <itooltip.h>

struct ITooltipPopup: public CCL::IUnknown
{
    // enums

    enum DurationCodes;

    // methods

    virtual void CCL_API construct (IView* view) = 0;
    virtual void CCL_API show () = 0;
    virtual void CCL_API hide () = 0;
    virtual void CCL_API setDuration (int64 ticks = kDefaultDuration) = 0;
    virtual int64 CCL_API getTimeToHide () = 0;
    virtual void CCL_API setPosition (PointRef pos, IView* view = nullptr) = 0;
    virtual void CCL_API moveToMouse () = 0;
    virtual void CCL_API setText (StringRef text) = 0;
    virtual StringRef CCL_API getText () const = 0;
    virtual tbool CCL_API isReserved () const = 0;
    virtual void CCL_API reserve (tbool state) = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Methods

virtual void CCL_API construct (IView* view) = 0

Initialize popup.

virtual void CCL_API show () = 0

Show popup.

virtual void CCL_API hide () = 0

Hide popup.

virtual void CCL_API setDuration (int64 ticks = kDefaultDuration) = 0

Hide popup after given ticks.

virtual int64 CCL_API getTimeToHide () = 0

Get time to hide (system ticks).

virtual void CCL_API setPosition (PointRef pos, IView* view = nullptr) = 0

Set position in client coordinates of a given view, or in screen coordinates.

virtual void CCL_API moveToMouse () = 0

Move near mouse position.

virtual void CCL_API setText (StringRef text) = 0

Set tooltip text.

virtual StringRef CCL_API getText () const = 0

Get tooltip text.

virtual tbool CCL_API isReserved () const = 0

Prevent others from showing tooltips, e.g.

when dragging a knob.