added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 13:52:38 +00:00
parent 5d713a7574
commit 23324ae1c7
272 changed files with 92200 additions and 9 deletions

74
interface/tooltip.h Normal file
View File

@@ -0,0 +1,74 @@
/////////////////////////////////////////////////////////////////////////////
// Name: tooltip.h
// Purpose: documentation for wxToolTip class
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxToolTip
@wxheader{tooltip.h}
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.
May not be supported on all platforms (eg. wxCocoa).
*/
static void Enable(bool flag);
/**
Get the tooltip text.
*/
wxString GetTip();
/**
Get the associated window.
*/
wxWindow* GetWindow();
/**
Set the delay after which the tooltip disappears or how long a
tooltip remains visible.
May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
*/
static void SetAutoPop(long msecs);
/**
Set the delay after which the tooltip appears.
May not be supported on all platforms (eg. wxCocoa).
*/
static void SetDelay(long msecs);
/**
Set the delay between subsequent tooltips to appear.
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);
};