be8b43858c
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58329 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
90 lines
2.3 KiB
Objective-C
90 lines
2.3 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: tooltip.h
|
|
// Purpose: interface of wxToolTip
|
|
// Author: wxWidgets team
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@class wxToolTip
|
|
|
|
This class holds information about a tooltip associated with a window (see
|
|
wxWindow::SetToolTip()).
|
|
|
|
The four static methods, wxToolTip::Enable(), wxToolTip::SetDelay()
|
|
wxToolTip::SetAutoPop() and wxToolTip::SetReshow() can be used to globally
|
|
alter tooltips behaviour.
|
|
|
|
@library{wxcore}
|
|
@category{help}
|
|
*/
|
|
class wxToolTip : public wxObject
|
|
{
|
|
public:
|
|
/**
|
|
Constructor.
|
|
*/
|
|
wxToolTip(const wxString& tip);
|
|
|
|
/**
|
|
Enable or disable tooltips globally.
|
|
|
|
@note May not be supported on all platforms (eg. wxCocoa).
|
|
*/
|
|
static void Enable(bool flag);
|
|
|
|
/**
|
|
Get the tooltip text.
|
|
*/
|
|
wxString GetTip() const;
|
|
|
|
/**
|
|
Get the associated window.
|
|
*/
|
|
wxWindow* GetWindow() const;
|
|
|
|
/**
|
|
Set the delay after which the tooltip disappears or how long a tooltip
|
|
remains visible.
|
|
|
|
@note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
|
|
*/
|
|
static void SetAutoPop(long msecs);
|
|
|
|
/**
|
|
Set the delay after which the tooltip appears.
|
|
|
|
@note May not be supported on all platforms (eg. wxCocoa).
|
|
*/
|
|
static void SetDelay(long msecs);
|
|
|
|
/**
|
|
Set tooltip maximal width in pixels.
|
|
|
|
By default, tooltips are wrapped at a suitably chosen width. You can
|
|
pass -1 as @a width to disable wrapping them completely, 0 to restore
|
|
the default behaviour or an arbitrary positive value to wrap them at
|
|
the given width.
|
|
|
|
Notice that this function does not change the width of the tooltips
|
|
created before calling it.
|
|
|
|
@note Currently this function is wxMSW-only.
|
|
*/
|
|
static void SetMaxWidth(int width) { ms_maxWidth = width; }
|
|
|
|
/**
|
|
Set the delay between subsequent tooltips to appear.
|
|
|
|
@note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
|
|
*/
|
|
static void SetReshow(long msecs);
|
|
|
|
/**
|
|
Set the tooltip text.
|
|
*/
|
|
void SetTip(const wxString& tip);
|
|
};
|
|
|