juce/source/src/gui/components/buttons/juce_DrawableButton.cpp

   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 #include "../../../core/juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_DrawableButton.h"
  31 #include "../lookandfeel/juce_LookAndFeel.h"
  32
  33
  34 //==============================================================================
  35 DrawableButton::DrawableButton (const String& name,
  36                                 const DrawableButton::ButtonStyle buttonStyle)
  37     : Button (name),
  38       style (buttonStyle),
  39       currentImage (nullptr),
  40       edgeIndent (3)
  41 {
  42     if (buttonStyle == ImageOnButtonBackground)
  43     {
  44         backgroundOff = Colour (0xffbbbbff);
  45         backgroundOn = Colour (0xff3333ff);
  46     }
  47     else
  48     {
  49         backgroundOff = Colours::transparentBlack;
  50         backgroundOn = Colour (0xaabbbbff);
  51     }
  52 }
  53
  54 DrawableButton::~DrawableButton()
  55 {
  56 }
  57
  58 //==============================================================================
  59 void DrawableButton::setImages (const Drawable* normal,
  60                                 const Drawable* over,
  61                                 const Drawable* down,
  62                                 const Drawable* disabled,
  63                                 const Drawable* normalOn,
  64                                 const Drawable* overOn,
  65                                 const Drawable* downOn,
  66                                 const Drawable* disabledOn)
  67 {
  68     jassert (normal != nullptr); // you really need to give it at least a normal image..
  69
  70     if (normal != nullptr)        normalImage = normal->createCopy();
  71     if (over != nullptr)          overImage = over->createCopy();
  72     if (down != nullptr)          downImage = down->createCopy();
  73     if (disabled != nullptr)      disabledImage = disabled->createCopy();
  74     if (normalOn != nullptr)      normalImageOn = normalOn->createCopy();
  75     if (overOn != nullptr)        overImageOn = overOn->createCopy();
  76     if (downOn != nullptr)        downImageOn = downOn->createCopy();
  77     if (disabledOn != nullptr)    disabledImageOn = disabledOn->createCopy();
  78
  79     buttonStateChanged();
  80 }
  81
  82 //==============================================================================
  83 void DrawableButton::setButtonStyle (const DrawableButton::ButtonStyle newStyle)
  84 {
  85     if (style != newStyle)
  86     {
  87         style = newStyle;
  88         buttonStateChanged();
  89     }
  90 }
  91
  92 void DrawableButton::setBackgroundColours (const Colour& toggledOffColour,
  93                                            const Colour& toggledOnColour)
  94 {
  95     if (backgroundOff != toggledOffColour
  96          || backgroundOn != toggledOnColour)
  97     {
  98         backgroundOff = toggledOffColour;
  99         backgroundOn = toggledOnColour;
 100
 101         repaint();
 102     }
 103 }
 104
 105 const Colour& DrawableButton::getBackgroundColour() const noexcept
 106 {
 107     return getToggleState() ? backgroundOn
 108                             : backgroundOff;
 109 }
 110
 111 void DrawableButton::setEdgeIndent (const int numPixelsIndent)
 112 {
 113     edgeIndent = numPixelsIndent;
 114     repaint();
 115     resized();
 116 }
 117
 118 void DrawableButton::resized()
 119 {
 120     Button::resized();
 121
 122     if (currentImage != nullptr)
 123     {
 124         if (style == ImageRaw)
 125         {
 126             currentImage->setOriginWithOriginalSize (Point<float>());
 127         }
 128         else
 129         {
 130             Rectangle<int> imageSpace;
 131
 132             if (style == ImageOnButtonBackground)
 133             {
 134                 imageSpace = getLocalBounds().reduced (getWidth() / 4, getHeight() / 4);
 135             }
 136             else
 137             {
 138                 const int textH = (style == ImageAboveTextLabel) ? jmin (16, proportionOfHeight (0.25f)) : 0;
 139
 140                 const int indentX = jmin (edgeIndent, proportionOfWidth (0.3f));
 141                 const int indentY = jmin (edgeIndent, proportionOfHeight (0.3f));
 142
 143                 imageSpace.setBounds (indentX, indentY,
 144                                       getWidth() - indentX * 2,
 145                                       getHeight() - indentY * 2 - textH);
 146             }
 147
 148             currentImage->setTransformToFit (imageSpace.toFloat(), RectanglePlacement::centred);
 149         }
 150     }
 151 }
 152
 153 void DrawableButton::buttonStateChanged()
 154 {
 155     repaint();
 156
 157     Drawable* imageToDraw = nullptr;
 158     float opacity = 1.0f;
 159
 160     if (isEnabled())
 161     {
 162         imageToDraw = getCurrentImage();
 163     }
 164     else
 165     {
 166         imageToDraw = getToggleState() ? disabledImageOn
 167                                        : disabledImage;
 168
 169         if (imageToDraw == nullptr)
 170         {
 171             opacity = 0.4f;
 172             imageToDraw = getNormalImage();
 173         }
 174     }
 175
 176     if (imageToDraw != currentImage)
 177     {
 178         removeChildComponent (currentImage);
 179         currentImage = imageToDraw;
 180
 181         if (currentImage != nullptr)
 182         {
 183             currentImage->setInterceptsMouseClicks (false, false);
 184             addAndMakeVisible (currentImage);
 185             DrawableButton::resized();
 186         }
 187     }
 188
 189     if (currentImage != nullptr)
 190         currentImage->setAlpha (opacity);
 191 }
 192
 193 void DrawableButton::paintButton (Graphics& g,
 194                                   bool isMouseOverButton,
 195                                   bool isButtonDown)
 196 {
 197     if (style == ImageOnButtonBackground)
 198     {
 199         getLookAndFeel().drawButtonBackground (g, *this,
 200                                                getBackgroundColour(),
 201                                                isMouseOverButton,
 202                                                isButtonDown);
 203     }
 204     else
 205     {
 206         g.fillAll (getBackgroundColour());
 207
 208         const int textH = (style == ImageAboveTextLabel)
 209                             ? jmin (16, proportionOfHeight (0.25f))
 210                             : 0;
 211
 212         if (textH > 0)
 213         {
 214             g.setFont ((float) textH);
 215
 216             g.setColour (findColour (DrawableButton::textColourId)
 217                             .withMultipliedAlpha (isEnabled() ? 1.0f : 0.4f));
 218
 219             g.drawFittedText (getButtonText(),
 220                               2, getHeight() - textH - 1,
 221                               getWidth() - 4, textH,
 222                               Justification::centred, 1);
 223         }
 224     }
 225 }
 226
 227 //==============================================================================
 228 Drawable* DrawableButton::getCurrentImage() const noexcept
 229 {
 230     if (isDown())
 231         return getDownImage();
 232
 233     if (isOver())
 234         return getOverImage();
 235
 236     return getNormalImage();
 237 }
 238
 239 Drawable* DrawableButton::getNormalImage() const noexcept
 240 {
 241     return (getToggleState() && normalImageOn != nullptr) ? normalImageOn
 242                                                           : normalImage;
 243 }
 244
 245 Drawable* DrawableButton::getOverImage() const noexcept
 246 {
 247     Drawable* d = normalImage;
 248
 249     if (getToggleState())
 250     {
 251         if (overImageOn != nullptr)
 252             d = overImageOn;
 253         else if (normalImageOn != nullptr)
 254             d = normalImageOn;
 255         else if (overImage != nullptr)
 256             d = overImage;
 257     }
 258     else
 259     {
 260         if (overImage != nullptr)
 261             d = overImage;
 262     }
 263
 264     return d;
 265 }
 266
 267 Drawable* DrawableButton::getDownImage() const noexcept
 268 {
 269     Drawable* d = normalImage;
 270
 271     if (getToggleState())
 272     {
 273         if (downImageOn != nullptr)
 274             d = downImageOn;
 275         else if (overImageOn != nullptr)
 276             d = overImageOn;
 277         else if (normalImageOn != nullptr)
 278             d = normalImageOn;
 279         else if (downImage != nullptr)
 280             d = downImage;
 281         else
 282             d = getOverImage();
 283     }
 284     else
 285     {
 286         if (downImage != nullptr)
 287             d = downImage;
 288         else
 289             d = getOverImage();
 290     }
 291
 292     return d;
 293 }
 294
 295 END_JUCE_NAMESPACE