juce/source/src/gui/components/special/juce_SystemTrayIconComponent.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_SYSTEMTRAYICONCOMPONENT_JUCEHEADER__
  27 #define __JUCE_SYSTEMTRAYICONCOMPONENT_JUCEHEADER__
  28
  29 #if JUCE_WINDOWS || JUCE_LINUX || DOXYGEN
  30
  31 #include "../juce_Component.h"
  32
  33
  34 //==============================================================================
  35 /**
  36     On Windows only, this component sits in the taskbar tray as a small icon.
  37
  38     To use it, just create one of these components, but don't attempt to make it
  39     visible, add it to a parent, or put it on the desktop.
  40
  41     You can then call setIconImage() to create an icon for it in the taskbar.
  42
  43     To change the icon's tooltip, you can use setIconTooltip().
  44
  45     To respond to mouse-events, you can override the normal mouseDown(),
  46     mouseUp(), mouseDoubleClick() and mouseMove() methods, and although the x, y
  47     position will not be valid, you can use this to respond to clicks. Traditionally
  48     you'd use a left-click to show your application's window, and a right-click
  49     to show a pop-up menu.
  50 */
  51 class JUCE_API  SystemTrayIconComponent  : public Component
  52 {
  53 public:
  54     //==============================================================================
  55     SystemTrayIconComponent();
  56
  57     /** Destructor. */
  58     ~SystemTrayIconComponent();
  59
  60     //==============================================================================
  61     /** Changes the image shown in the taskbar.
  62     */
  63     void setIconImage (const Image& newImage);
  64
  65     /** Changes the tooltip that Windows shows above the icon. */
  66     void setIconTooltip (const String& tooltip);
  67
  68 #if JUCE_LINUX
  69     /** @internal */
  70     void paint (Graphics& g);
  71 #endif
  72
  73
  74 private:
  75     //==============================================================================
  76     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SystemTrayIconComponent);
  77 };
  78
  79
  80 #endif
  81 #endif   // __JUCE_SYSTEMTRAYICONCOMPONENT_JUCEHEADER__