<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxTaskBarIcon</title>
</header>
<module>wxTaskBarIcon</module>
<modulesummary>Functions for wxTaskBarIcon class</modulesummary>
<description><p>This class represents a taskbar icon. A taskbar icon is an icon that appears in the 'system tray' and responds to mouse clicks, optionally with a tooltip above it to help provide information.
      </p><p>X Window System Note</p> <p>Under X Window System, the window manager must support either the "System Tray Protocol" (see <url href="http://freedesktop.org/wiki/Specifications/systemtray-spec">http://freedesktop.org/wiki/Specifications/systemtray-spec</url>) by freedesktop.org (WMs used by modern desktop environments such as GNOME &gt;= 2, KDE &gt;= 3 and XFCE &gt;= 4 all do) or the older methods used in GNOME 1.2 and KDE 1 and 2.
      </p> <p>If it doesn't, the icon will appear as a toplevel window on user's desktop. Because not all window managers have system tray, there's no guarantee that <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl> will work correctly under X Window System and so the applications should use it only as an optional component of their user interface. The user should be required to explicitly enable the taskbar icon on Unix, it shouldn't be on by default.
      </p> 
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_task_bar_icon.html">wxTaskBarIcon</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxTaskBarIconEvent"><c>taskbar_move</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_left_down</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_left_up</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_right_down</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_right_up</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_left_dclick</c></seeerl>, <seeerl marker="wxTaskBarIconEvent"><c>taskbar_right_dclick</c></seeerl></p></section>
<datatypes><datatype><name name="wxTaskBarIcon"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p><p>The iconType is only applicable on wxOSX/Cocoa. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destroys the <c>wxTaskBarIcon</c> object, removing the icon if not already removed. </fsummary>
    <desc><p>Destroys the <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl> object, removing the icon if not already removed. 
      </p></desc>
  </func>
  
  <func>
    <name name="popupMenu" arity="2" clause_i="1" since=""/>
    <fsummary>Pops up a menu at the current mouse position. </fsummary>
    <desc><p>Pops up a menu at the current mouse position. 
      </p><p>The events can be handled by a class derived from <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl>.
      </p><p>Note: It is recommended to override <c>CreatePopupMenu()</c> (not implemented in wx) callback instead of calling this method from event handler, because some ports (e.g. wxCocoa) may not implement <seemfa marker="#popupMenu/2"><c>popupMenu/2</c></seemfa> and mouse click events at all. 
      </p></desc>
  </func>
  
  <func>
    <name name="removeIcon" arity="1" clause_i="1" since=""/>
    <fsummary>Removes the icon previously set with <c>setIcon/3</c>. </fsummary>
    <desc><p>Removes the icon previously set with <seemfa marker="#setIcon/3"><c>setIcon/3</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setIcon" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setIcon/3</c></fsummary>
  </func>
  
  <func>
    <name name="setIcon" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the icon, and optional tooltip text. </fsummary>
    <desc><p>Sets the icon, and optional tooltip text. 
      </p></desc>
  </func>
  </funcs>
</erlref>
