DISTRHO
/
JUCE
mirror of https://github.com/DISTRHO/JUCE
1
0
Fork 0
Code Releases 1 Activity
The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8030 Commits
9 Branches
2.8GB
Tree: 06623fc99c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '06623fc99c'
${ noResults }
JUCE/extras/Projucer/Source/ComponentEditor/Components/jucer_ImageButtonHandler.h

536 lines
19KB
Raw Blame History 

  1. /*

  2.   ==============================================================================

  3. 

  4.    This file is part of the JUCE library.

  5.    Copyright (c) 2017 - ROLI Ltd.

  6. 

  7.    JUCE is an open source library subject to commercial or open-source

  8.    licensing.

  9. 

  10.    By using JUCE, you agree to the terms of both the JUCE 5 End-User License

  11.    Agreement and JUCE 5 Privacy Policy (both updated and effective as of the

  12.    27th April 2017).

  13. 

  14.    End User License Agreement: www.juce.com/juce-5-licence

  15.    Privacy Policy: www.juce.com/juce-5-privacy-policy

  16. 

  17.    Or: You may also use this code under the terms of the GPL v3 (see

  18.    www.gnu.org/licenses).

  19. 

  20.    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER

  21.    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE

  22.    DISCLAIMED.

  23. 

  24.   ==============================================================================

  25. */

  26. 

  27. #pragma once

  28. 

  29. 

  30. //==============================================================================

  31. class ImageButtonHandler  : public ButtonHandler

  32. {

  33. public:

  34.     enum ImageRole

  35.     {

  36.         normalImage = 0,

  37.         overImage = 1,

  38.         downImage = 2

  39.     };

  40. 

  41.     //==============================================================================

  42.     ImageButtonHandler()

  43.         : ButtonHandler ("Image Button", "ImageButton", typeid (ImageButton), 150, 24)

  44.     {

  45.     }

  46. 

  47.     Component* createNewComponent (JucerDocument*) override

  48.     {

  49.         return new ImageButton ("new button");

  50.     }

  51. 

  52.     void getEditableProperties (Component* component, JucerDocument& document,

  53.                                 Array<PropertyComponent*>& props, bool multipleSelected) override

  54.     {

  55.         ButtonHandler::getEditableProperties (component, document, props, multipleSelected);

  56. 

  57.         if (multipleSelected)

  58.             return;

  59. 

  60.         addColourProperties (component, document, props);

  61. 

  62.         if (auto* ib = dynamic_cast<ImageButton*> (component))

  63.         {

  64.             auto& layout = *document.getComponentLayout();

  65. 

  66.             props.add (new ImageButtonProportionProperty (layout, ib));

  67. 

  68.             props.add (new ImageButtonResourceProperty (layout, ib, normalImage, "normal image"));

  69.             props.add (new ImageButtonOpacityProperty (layout, ib, "opacity", normalImage));

  70.             props.add (new ImageButtonColourProperty (layout, ib, "overlay col.", normalImage));

  71. 

  72.             props.add (new ImageButtonResourceProperty (layout, ib, overImage, "over image"));

  73.             props.add (new ImageButtonOpacityProperty (layout, ib, "opacity", overImage));

  74.             props.add (new ImageButtonColourProperty (layout, ib, "overlay col.", overImage));

  75. 

  76.             props.add (new ImageButtonResourceProperty (layout, ib, downImage, "down image"));

  77.             props.add (new ImageButtonOpacityProperty (layout, ib, "opacity", downImage));

  78.             props.add (new ImageButtonColourProperty (layout, ib, "overlay col.", downImage));

  79.         }

  80.     }

  81. 

  82.     XmlElement* createXmlFor (Component* comp, const ComponentLayout* layout) override

  83.     {

  84.         XmlElement* e = ButtonHandler::createXmlFor (comp, layout);

  85. 

  86.         ImageButton* const ib = (ImageButton*) comp;

  87. 

  88.         e->setAttribute ("keepProportions", doesImageKeepProportions (ib));

  89. 

  90.         e->setAttribute ("resourceNormal", getImageResource (ib, normalImage));

  91.         e->setAttribute ("opacityNormal", getImageOpacity (ib, normalImage));

  92.         e->setAttribute ("colourNormal", getImageColour (ib, normalImage).toString());

  93. 

  94.         e->setAttribute ("resourceOver", getImageResource (ib, overImage));

  95.         e->setAttribute ("opacityOver", getImageOpacity (ib, overImage));

  96.         e->setAttribute ("colourOver", getImageColour (ib, overImage).toString());

  97. 

  98.         e->setAttribute ("resourceDown", getImageResource (ib, downImage));

  99.         e->setAttribute ("opacityDown", getImageOpacity (ib, downImage));

  100.         e->setAttribute ("colourDown", getImageColour (ib, downImage).toString());

  101. 

  102.         return e;

  103.     }

  104. 

  105.     bool restoreFromXml (const XmlElement& xml, Component* comp, const ComponentLayout* layout) override

  106.     {

  107.         if (! ButtonHandler::restoreFromXml (xml, comp, layout))

  108.             return false;

  109. 

  110.         ImageButton* const ib = (ImageButton*) comp;

  111.         ComponentLayout& l = const_cast<ComponentLayout&> (*layout);

  112. 

  113.         setImageKeepProportions (l, ib, xml.getBoolAttribute ("keepProportions", true), false);

  114. 

  115.         setImageResource (l, ib, normalImage, xml.getStringAttribute ("resourceNormal", String()), false);

  116.         setImageOpacity (l, ib, normalImage, (float) xml.getDoubleAttribute ("opacityNormal", 1.0f), false);

  117.         setImageColour (l, ib, normalImage, Colour::fromString (xml.getStringAttribute ("colourNormal", "0")), false);

  118. 

  119.         setImageResource (l, ib, overImage, xml.getStringAttribute ("resourceOver", String()), false);

  120.         setImageOpacity (l, ib, overImage, (float) xml.getDoubleAttribute ("opacityOver", 1.0f), false);

  121.         setImageColour (l, ib, overImage, Colour::fromString (xml.getStringAttribute ("colourOver", "0")), false);

  122. 

  123.         setImageResource (l, ib, downImage, xml.getStringAttribute ("resourceDown", String()), false);

  124.         setImageOpacity (l, ib, downImage, (float) xml.getDoubleAttribute ("opacityDown", 1.0f), false);

  125.         setImageColour (l, ib, downImage, Colour::fromString (xml.getStringAttribute ("colourDown", "0")), false);

  126. 

  127.         return true;

  128.     }

  129. 

  130.     void fillInCreationCode (GeneratedCode& code, Component* component, const String& memberVariableName) override

  131.     {

  132.         ButtonHandler::fillInCreationCode (code, component, memberVariableName);

  133. 

  134.         ImageButton* const ib = dynamic_cast<ImageButton*> (component);

  135. 

  136.         String s;

  137. 

  138.         s << getColourIntialisationCode (component, memberVariableName)

  139.           << '\n';

  140. 

  141.         const String indent (String::repeatedString (" ", memberVariableName.length() + 13));

  142. 

  143.         s << memberVariableName << "->setImages (false, true, "

  144.           << CodeHelpers::boolLiteral (doesImageKeepProportions (ib)) << ",\n"

  145.           << indent

  146.           << getImageCreationCode (ib, normalImage) << ", "

  147.           << CodeHelpers::floatLiteral (getImageOpacity (ib, normalImage), 3) << ", "

  148.           << CodeHelpers::colourToCode (getImageColour (ib, normalImage)) << ",\n"

  149.           << indent

  150.           << getImageCreationCode (ib, overImage) << ", "

  151.           << CodeHelpers::floatLiteral (getImageOpacity (ib, overImage), 3) << ", "

  152.           << CodeHelpers::colourToCode (getImageColour (ib, overImage)) << ",\n"

  153.           << indent

  154.           << getImageCreationCode (ib, downImage) << ", "

  155.           << CodeHelpers::floatLiteral (getImageOpacity (ib, downImage), 3) << ", "

  156.           << CodeHelpers::colourToCode (getImageColour (ib, downImage))

  157.           << ");\n";

  158. 

  159.         code.constructorCode += s;

  160.     }

  161. 

  162.     static String getImageCreationCode (ImageButton* ib, const ImageRole role)

  163.     {

  164.         const String resName (getImageResource (ib, role));

  165. 

  166.         if (resName.isEmpty())

  167.             return "Image()";

  168. 

  169.         return "ImageCache::getFromMemory (" + resName + ", " + resName + "Size)";

  170.     }

  171. 

  172.     //==============================================================================

  173.     class ImageButtonResourceProperty    : public ImageResourceProperty <ImageButton>

  174.     {

  175.     public:

  176.         ImageButtonResourceProperty (ComponentLayout& layout_, ImageButton* const owner_, const ImageRole role_, const String& name)

  177.             : ImageResourceProperty <ImageButton> (*layout_.getDocument(), owner_, name, true),

  178.               role (role_),

  179.               layout (layout_)

  180.         {

  181.         }

  182. 

  183.         void setResource (const String& newName)

  184.         {

  185.             setImageResource (layout, element, role, newName, true);

  186.         }

  187. 

  188.         String getResource() const

  189.         {

  190.             return getImageResource (element, role);

  191.         }

  192. 

  193.     private:

  194.         const ImageRole role;

  195.         ComponentLayout& layout;

  196.     };

  197. 

  198.     class SetImageResourceAction   : public ComponentUndoableAction <ImageButton>

  199.     {

  200.     public:

  201.         SetImageResourceAction (ImageButton* const button,

  202.                                 ComponentLayout& layout_,

  203.                                 const ImageRole role_,

  204.                                 const String& newResource_)

  205.             : ComponentUndoableAction <ImageButton> (button, layout_),

  206.               newResource (newResource_),

  207.               role (role_),

  208.               layout (layout_)

  209.         {

  210.             oldResource = ImageButtonHandler::getImageResource (button, role_);

  211.         }

  212. 

  213.         bool perform()

  214.         {

  215.             showCorrectTab();

  216.             ImageButtonHandler::setImageResource (layout, getComponent(), role, newResource, false);

  217.             return true;

  218.         }

  219. 

  220.         bool undo()

  221.         {

  222.             showCorrectTab();

  223.             ImageButtonHandler::setImageResource (layout, getComponent(), role, oldResource, false);

  224.             return true;

  225.         }

  226. 

  227.     private:

  228.         String newResource, oldResource;

  229.         const ImageRole role;

  230.         ComponentLayout& layout;

  231.     };

  232. 

  233.     //==============================================================================

  234.     static void setImageResource (ComponentLayout& layout, ImageButton* button, const ImageRole role, const String& newName, const bool undoable)

  235.     {

  236.         jassert (role < 3);

  237. 

  238.         if (role < 3 && getImageResource (button, role) != newName)

  239.         {

  240.             if (undoable)

  241.             {

  242.                 layout.getDocument()->perform (new SetImageResourceAction (button, layout, role, newName),

  243.                                                "Change image resource");

  244.             }

  245.             else

  246.             {

  247.                 button->getProperties().set ("resource" + String ((int) role), newName);

  248.                 updateButtonImages (*layout.getDocument(), button);

  249.                 layout.changed();

  250.             }

  251.         }

  252.     }

  253. 

  254.     static String getImageResource (ImageButton* button, const ImageRole role)

  255.     {

  256.         jassert (role < 3);

  257.         return button->getProperties() ["resource" + String ((int) role)].toString();

  258.     }

  259. 

  260.     //==============================================================================

  261.     class SetImageKeepsPropAction   : public ComponentUndoableAction <ImageButton>

  262.     {

  263.     public:

  264.         SetImageKeepsPropAction (ImageButton* const button,

  265.                                  ComponentLayout& layout_,

  266.                                  const bool newState_)

  267.             : ComponentUndoableAction <ImageButton> (button, layout_),

  268.               newState (newState_),

  269.               layout (layout_)

  270.         {

  271.             oldState = ImageButtonHandler::doesImageKeepProportions (button);

  272.         }

  273. 

  274.         bool perform()

  275.         {

  276.             showCorrectTab();

  277.             ImageButtonHandler::setImageKeepProportions (layout, getComponent(), newState, false);

  278.             return true;

  279.         }

  280. 

  281.         bool undo()

  282.         {

  283.             showCorrectTab();

  284.             ImageButtonHandler::setImageKeepProportions (layout, getComponent(), oldState, false);

  285.             return true;

  286.         }

  287. 

  288.     private:

  289.         bool newState, oldState;

  290.         ComponentLayout& layout;

  291.     };

  292. 

  293.     static bool doesImageKeepProportions (ImageButton* button)

  294.     {

  295.         return button->getProperties().getWithDefault ("keepImageProp", true);

  296.     }

  297. 

  298.     static void setImageKeepProportions (ComponentLayout& layout, ImageButton* button, const bool newState, const bool undoable)

  299.     {

  300.         if (undoable)

  301.         {

  302.             layout.perform (new SetImageKeepsPropAction (button, layout, newState), "change imagebutton proportion mode");

  303.         }

  304.         else

  305.         {

  306.             button->getProperties().set ("keepImageProp", newState);

  307.             updateButtonImages (*layout.getDocument(), button);

  308.             layout.changed();

  309.         }

  310.     }

  311. 

  312.     class ImageButtonProportionProperty    : public ComponentBooleanProperty <ImageButton>

  313.     {

  314.     public:

  315.         ImageButtonProportionProperty (ComponentLayout& layout_, ImageButton* const owner_)

  316.             : ComponentBooleanProperty <ImageButton> ("proportional", "maintain image proportions", "scale to fit",

  317.                                                       owner_, *layout_.getDocument()),

  318.               layout (layout_)

  319.         {

  320.         }

  321. 

  322.         void setState (bool newState)

  323.         {

  324.             setImageKeepProportions (layout, component, newState, true);

  325.         }

  326. 

  327.         bool getState() const

  328.         {

  329.             return doesImageKeepProportions (component);

  330.         }

  331. 

  332.     private:

  333.         ComponentLayout& layout;

  334.     };

  335. 

  336.     //==============================================================================

  337.     class SetImageOpacityAction   : public ComponentUndoableAction <ImageButton>

  338.     {

  339.     public:

  340.         SetImageOpacityAction (ImageButton* const button,

  341.                                ComponentLayout& layout_,

  342.                                const ImageRole role_,

  343.                                const float newState_)

  344.             : ComponentUndoableAction <ImageButton> (button, layout_),

  345.               role (role_),

  346.               newState (newState_),

  347.               layout (layout_)

  348.         {

  349.             oldState = ImageButtonHandler::getImageOpacity (button, role_);

  350.         }

  351. 

  352.         bool perform()

  353.         {

  354.             showCorrectTab();

  355.             ImageButtonHandler::setImageOpacity (layout, getComponent(), role, newState, false);

  356.             return true;

  357.         }

  358. 

  359.         bool undo()

  360.         {

  361.             showCorrectTab();

  362.             ImageButtonHandler::setImageOpacity (layout, getComponent(), role, oldState, false);

  363.             return true;

  364.         }

  365. 

  366.     private:

  367.         const ImageRole role;

  368.         float newState, oldState;

  369.         ComponentLayout& layout;

  370.     };

  371. 

  372.     static float getImageOpacity (ImageButton* button, const ImageRole role)

  373.     {

  374.         return (float) button->getProperties().getWithDefault ("imageOpacity" + String ((int) role), 1.0f);

  375.     }

  376. 

  377.     static void setImageOpacity (ComponentLayout& layout, ImageButton* button, const ImageRole role, const float opacity, const bool undoable)

  378.     {

  379.         if (undoable)

  380.         {

  381.             layout.perform (new SetImageOpacityAction (button, layout, role, opacity), "change imagebutton opacity");

  382.         }

  383.         else

  384.         {

  385.             button->getProperties().set ("imageOpacity" + String ((int) role), opacity);

  386.             updateButtonImages (*layout.getDocument(), button);

  387.             layout.changed();

  388.         }

  389.     }

  390. 

  391.     class ImageButtonOpacityProperty    : public SliderPropertyComponent

  392.     {

  393.     public:

  394.         ImageButtonOpacityProperty (ComponentLayout& layout_, ImageButton* const owner_,

  395.                                     const String& name, const ImageRole role_)

  396.             : SliderPropertyComponent (name, 0.0, 1.0, 0.0),

  397.               owner (owner_),

  398.               layout (layout_),

  399.               role (role_)

  400.         {

  401.         }

  402. 

  403.         void setValue (double newValue)

  404.         {

  405.             setImageOpacity (layout, owner, role, (float) newValue, true);

  406.         }

  407. 

  408.         double getValue() const

  409.         {

  410.             return getImageOpacity (owner, role);

  411.         }

  412. 

  413.     private:

  414.         ImageButton* const owner;

  415.         ComponentLayout& layout;

  416.         const ImageRole role;

  417.     };

  418. 

  419.     //==============================================================================

  420.     class SetImageColourAction   : public ComponentUndoableAction <ImageButton>

  421.     {

  422.     public:

  423.         SetImageColourAction (ImageButton* const button,

  424.                               ComponentLayout& layout_,

  425.                               const ImageRole role_,

  426.                               Colour newState_)

  427.             : ComponentUndoableAction<ImageButton> (button, layout_),

  428.               role (role_),

  429.               newState (newState_),

  430.               layout (layout_)

  431.         {

  432.             oldState = ImageButtonHandler::getImageColour (button, role_);

  433.         }

  434. 

  435.         bool perform()

  436.         {

  437.             showCorrectTab();

  438.             ImageButtonHandler::setImageColour (layout, getComponent(), role, newState, false);

  439.             return true;

  440.         }

  441. 

  442.         bool undo()

  443.         {

  444.             showCorrectTab();

  445.             ImageButtonHandler::setImageColour (layout, getComponent(), role, oldState, false);

  446.             return true;

  447.         }

  448. 

  449.     private:

  450.         const ImageRole role;

  451.         Colour newState, oldState;

  452.         ComponentLayout& layout;

  453.     };

  454. 

  455.     static Colour getImageColour (ImageButton* button, const ImageRole role)

  456.     {

  457.         return Colour::fromString (button->getProperties().getWithDefault ("imageColour" + String ((int) role), "0").toString());

  458.     }

  459. 

  460.     static void setImageColour (ComponentLayout& layout, ImageButton* button,

  461.                                 const ImageRole role, Colour colour, const bool undoable)

  462.     {

  463.         if (undoable)

  464.         {

  465.             layout.perform (new SetImageColourAction (button, layout, role, colour), "change imagebutton colour");

  466.         }

  467.         else

  468.         {

  469.             button->getProperties().set ("imageColour" + String ((int) role), colour.toString());

  470.             updateButtonImages (*layout.getDocument(), button);

  471.             layout.changed();

  472.         }

  473.     }

  474. 

  475.     class ImageButtonColourProperty    : public JucerColourPropertyComponent,

  476.                                          public ChangeListener

  477.     {

  478.     public:

  479.         ImageButtonColourProperty (ComponentLayout& layout_, ImageButton* const owner_,

  480.                                    const String& name, const ImageRole role_)

  481.             : JucerColourPropertyComponent (name, false),

  482.               owner (owner_),

  483.               layout (layout_),

  484.               role (role_)

  485.         {

  486.             layout_.getDocument()->addChangeListener (this);

  487.         }

  488. 

  489.         ~ImageButtonColourProperty()

  490.         {

  491.             layout.getDocument()->removeChangeListener (this);

  492.         }

  493. 

  494.         void setColour (Colour newColour)

  495.         {

  496.             setImageColour (layout, owner, role, newColour, true);

  497.         }

  498. 

  499.         Colour getColour() const

  500.         {

  501.             return getImageColour (owner, role);

  502.         }

  503. 

  504.         void resetToDefault() {}

  505. 

  506.         void changeListenerCallback (ChangeBroadcaster*)

  507.         {

  508.             refresh();

  509.         }

  510. 

  511.     private:

  512.         ImageButton* const owner;

  513.         ComponentLayout& layout;

  514.         const ImageRole role;

  515.     };

  516. 

  517.     //==============================================================================

  518.     static void updateButtonImages (JucerDocument& document, ImageButton* const ib)

  519.     {

  520.         Image norm = document.getResources().getImageFromCache (getImageResource (ib, normalImage));

  521.         Image over = document.getResources().getImageFromCache (getImageResource (ib, overImage));

  522.         Image down = document.getResources().getImageFromCache (getImageResource (ib, downImage));

  523. 

  524.         ib->setImages (false, true, doesImageKeepProportions (ib),

  525.                        norm,

  526.                        getImageOpacity (ib, normalImage),

  527.                        getImageColour (ib, normalImage),

  528.                        over,

  529.                        getImageOpacity (ib, overImage),

  530.                        getImageColour (ib, overImage),

  531.                        down,

  532.                        getImageOpacity (ib, downImage),

  533.                        getImageColour (ib, downImage));

  534.     }

  535. };