1wxTaskBarIcon(3)           Erlang Module Definition           wxTaskBarIcon(3)
2
3
4

NAME

6       wxTaskBarIcon - Functions for wxTaskBarIcon class
7

DESCRIPTION

9       This  class  represents  a taskbar icon. A taskbar icon is an icon that
10       appears in the 'system tray' and responds to mouse  clicks,  optionally
11       with a tooltip above it to help provide information.
12
13       X Window System Note
14
15       Under X Window System, the window manager must support either the "Sys‐
16       tem Tray Protocol" (see http://freedesktop.org/wiki/Specifications/sys‐
17       temtray-spec)  by  freedesktop.org (WMs used by modern desktop environ‐
18       ments such as GNOME >= 2, KDE >= 3 and XFCE >= 4 all do) or  the  older
19       methods used in GNOME 1.2 and KDE 1 and 2.
20
21       If  it  doesn't,  the  icon  will appear as a toplevel window on user's
22       desktop. Because not all window managers have system tray,  there's  no
23       guarantee  that wxTaskBarIcon will work correctly under X Window System
24       and so the applications should use it only as an optional component  of
25       their  user interface. The user should be required to explicitly enable
26       the taskbar icon on Unix, it shouldn't be on by default.
27
28       This class is derived (and can use functions) from: wxEvtHandler
29
30       wxWidgets docs: wxTaskBarIcon
31

EVENTS

33       Event types emitted from this class:  taskbar_move,  taskbar_left_down,
34       taskbar_left_up,          taskbar_right_down,         taskbar_right_up,
35       taskbar_left_dclick, taskbar_right_dclick
36

DATA TYPES

38       wxTaskBarIcon() = wx:wx_object()
39

EXPORTS

41       new(Options :: [Option]) -> wxTaskBarIcon()
42
43              Types:
44
45                 Option =
46                     {iconType, wx:wx_enum()} |
47                     {createPopupMenu, fun(() -> wxMenu:wxMenu())}
48
49              Default constructor.
50
51              The iconType is only applicable on wxOSX/Cocoa.
52
53       destroy(This :: wxTaskBarIcon()) -> ok
54
55              Destroys the wxTaskBarIcon object, removing the icon if not  al‐
56              ready removed.
57
58       popupMenu(This, Menu) -> boolean()
59
60              Types:
61
62                 This = wxTaskBarIcon()
63                 Menu = wxMenu:wxMenu()
64
65              Pops up a menu at the current mouse position.
66
67              The events can be handled by a class derived from wxTaskBarIcon.
68
69              Note:  It  is recommended to override CreatePopupMenu() (not im‐
70              plemented in wx) callback instead of calling  this  method  from
71              event  handler, because some ports (e.g. wxCocoa) may not imple‐
72              ment popupMenu/2 and mouse click events at all.
73
74       removeIcon(This) -> boolean()
75
76              Types:
77
78                 This = wxTaskBarIcon()
79
80              Removes the icon previously set with setIcon/3.
81
82       setIcon(This, Icon) -> boolean()
83
84              Types:
85
86                 This = wxTaskBarIcon()
87                 Icon = wxIcon:wxIcon()
88
89       setIcon(This, Icon, Options :: [Option]) -> boolean()
90
91              Types:
92
93                 This = wxTaskBarIcon()
94                 Icon = wxIcon:wxIcon()
95                 Option = {tooltip, unicode:chardata()}
96
97              Sets the icon, and optional tooltip text.
98
99
100
101wxWidgets team.                     wx 2.1                    wxTaskBarIcon(3)