wxwidgets/include/wx/osx/tooltip.h
Vadim Zeitlin e43f913313 Remove all blank "Modified by:" lines from top comment blocks
Having this line is not useful at all as it doesn't contain any
information and shouldn't be filled in the future as git-shortlog can
provide the information about people who changed the given file more
more reliably than consulting the comments in any case.

Keep the non-blank lines for historical purposes.
2023-10-22 01:22:48 +02:00

56 lines
1.9 KiB
C++

///////////////////////////////////////////////////////////////////////////////
// Name: wx/osx/tooltip.h
// Purpose: wxToolTip class - tooltip control
// Author: Stefan Csomor
// Created: 31.01.99
// Copyright: (c) 1999 Robert Roebling, Vadim Zeitlin, Stefan Csomor
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_MAC_TOOLTIP_H_
#define _WX_MAC_TOOLTIP_H_
#include "wx/string.h"
#include "wx/event.h"
class WXDLLIMPEXP_CORE wxToolTip : public wxObject
{
public:
// ctor & dtor
wxToolTip(const wxString &tip);
virtual ~wxToolTip();
// accessors
// tip text
void SetTip(const wxString& tip);
const wxString& GetTip() const { return m_text; }
// the window we're associated with
void SetWindow(wxWindow *win);
wxWindow *GetWindow() const { return m_window; }
// controlling tooltip behaviour: globally change tooltip parameters
// enable or disable the tooltips globally
static void Enable(bool flag);
// set the delay after which the tooltip appears
static void SetDelay(long milliseconds);
// set the delay after which the tooltip disappears or how long the tooltip remains visible
static void SetAutoPop(long milliseconds);
// set the delay between subsequent tooltips to appear
static void SetReshow(long milliseconds);
static void NotifyWindowDelete( WXHWND win ) ;
// implementation only from now on
// -------------------------------
// should be called in response to mouse events
static void RelayEvent(wxWindow *win , wxMouseEvent &event);
static void RemoveToolTips();
private:
wxString m_text; // tooltip text
wxWindow *m_window; // window we're associated with
wxDECLARE_ABSTRACT_CLASS(wxToolTip);
};
#endif // _WX_MAC_TOOLTIP_H_