]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/msw/taskbar.h
wxMessageBox off the main thread lost result code.
[wxWidgets.git] / include / wx / msw / taskbar.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////
2// File: wx/msw/taskbar.h
3// Purpose: Defines wxTaskBarIcon class for manipulating icons on the
4// Windows task bar.
5// Author: Julian Smart
6// Modified by: Vaclav Slavik
7// Created: 24/3/98
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_TASKBAR_H_
13#define _WX_TASKBAR_H_
14
15#include "wx/icon.h"
16
17// private helper class:
18class WXDLLIMPEXP_FWD_ADV wxTaskBarIconWindow;
19
20class WXDLLIMPEXP_ADV wxTaskBarIcon : public wxTaskBarIconBase
21{
22public:
23 wxTaskBarIcon(wxTaskBarIconType iconType = wxTBI_DEFAULT_TYPE);
24 virtual ~wxTaskBarIcon();
25
26 // Accessors
27 bool IsOk() const { return true; }
28 bool IsIconInstalled() const { return m_iconAdded; }
29
30 // Operations
31 bool SetIcon(const wxIcon& icon, const wxString& tooltip = wxEmptyString);
32 bool RemoveIcon(void);
33 bool PopupMenu(wxMenu *menu);
34
35 // MSW-specific class methods
36
37#if wxUSE_TASKBARICON_BALLOONS
38 // show a balloon notification (the icon must have been already initialized
39 // using SetIcon)
40 //
41 // title and text are limited to 63 and 255 characters respectively, msec
42 // is the timeout, in milliseconds, before the balloon disappears (will be
43 // clamped down to the allowed 10-30s range by Windows if it's outside it)
44 // and flags can include wxICON_ERROR/INFO/WARNING to show a corresponding
45 // icon
46 //
47 // return true if balloon was shown, false on error (incorrect parameters
48 // or function unsupported by OS)
49 bool ShowBalloon(const wxString& title,
50 const wxString& text,
51 unsigned msec = 0,
52 int flags = 0);
53#endif // wxUSE_TASKBARICON_BALLOONS
54
55protected:
56 friend class wxTaskBarIconWindow;
57
58 long WindowProc(unsigned int msg, unsigned int wParam, long lParam);
59 void RegisterWindowMessages();
60
61
62 wxTaskBarIconWindow *m_win;
63 bool m_iconAdded;
64 wxIcon m_icon;
65 wxString m_strTooltip;
66
67 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTaskBarIcon)
68};
69
70#endif // _WX_TASKBAR_H_