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.
11026 Commits
9 Branches
4.8GB
Tree: 092bc44413
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '092bc44413'
${ noResults }
JUCE/extras/Projucer/Source/ComponentEditor/Components/jucer_ImageButtonHandler.h

520 lines
19KB
Raw Blame History 

  1. /*

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

  3. 

  4.    This file is part of the JUCE 6 technical preview.

  5.    Copyright (c) 2020 - Raw Material Software Limited

  6. 

  7.    You may use this code under the terms of the GPL v3

  8.    (see www.gnu.org/licenses).

  9. 

  10.    For this technical preview, this file is not subject to commercial licensing.

  11. 

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

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

  14.    DISCLAIMED.

  15. 

  16.   ==============================================================================

  17. */

  18. 

  19. #pragma once

  20. 

  21. 

  22. //==============================================================================

  23. class ImageButtonHandler  : public ButtonHandler

  24. {

  25. public:

  26.     enum ImageRole

  27.     {

  28.         normalImage = 0,

  29.         overImage = 1,

  30.         downImage = 2

  31.     };

  32. 

  33.     //==============================================================================

  34.     ImageButtonHandler()

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

  36.     {

  37.     }

  38. 

  39.     Component* createNewComponent (JucerDocument*) override

  40.     {

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

  42.     }

  43. 

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

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

  46.     {

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

  48. 

  49.         if (multipleSelected)

  50.             return;

  51. 

  52.         addColourProperties (component, document, props);

  53. 

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

  55.         {

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

  57. 

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

  59. 

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

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

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

  63. 

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

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

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

  67. 

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

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

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

  71.         }

  72.     }

  73. 

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

  75.     {

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

  77. 

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

  79. 

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

  81. 

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

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

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

  85. 

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

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

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

  89. 

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

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

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

  93. 

  94.         return e;

  95.     }

  96. 

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

  98.     {

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

  100.             return false;

  101. 

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

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

  104. 

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

  106. 

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

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

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

  110. 

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

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

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

  114. 

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

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

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

  118. 

  119.         return true;

  120.     }

  121. 

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

  123.     {

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

  125. 

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

  127. 

  128.         String s;

  129. 

  130.         s << getColourIntialisationCode (component, memberVariableName)

  131.           << '\n';

  132. 

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

  134. 

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

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

  137.           << indent

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

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

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

  141.           << indent

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

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

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

  145.           << indent

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

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

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

  149.           << ");\n";

  150. 

  151.         code.constructorCode += s;

  152.     }

  153. 

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

  155.     {

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

  157. 

  158.         if (resName.isEmpty())

  159.             return "juce::Image()";

  160. 

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

  162.     }

  163. 

  164.     //==============================================================================

  165.     class ImageButtonResourceProperty    : public ImageResourceProperty<ImageButton>

  166.     {

  167.     public:

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

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

  170.               role (role_),

  171.               layout (layout_)

  172.         {

  173.         }

  174. 

  175.         void setResource (const String& newName)

  176.         {

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

  178.         }

  179. 

  180.         String getResource() const

  181.         {

  182.             return getImageResource (element, role);

  183.         }

  184. 

  185.     private:

  186.         const ImageRole role;

  187.         ComponentLayout& layout;

  188.     };

  189. 

  190.     class SetImageResourceAction   : public ComponentUndoableAction<ImageButton>

  191.     {

  192.     public:

  193.         SetImageResourceAction (ImageButton* const button,

  194.                                 ComponentLayout& layout_,

  195.                                 const ImageRole role_,

  196.                                 const String& newResource_)

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

  198.               newResource (newResource_),

  199.               role (role_)

  200.         {

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

  202.         }

  203. 

  204.         bool perform() override

  205.         {

  206.             showCorrectTab();

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

  208.             return true;

  209.         }

  210. 

  211.         bool undo() override

  212.         {

  213.             showCorrectTab();

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

  215.             return true;

  216.         }

  217. 

  218.     private:

  219.         String newResource, oldResource;

  220.         const ImageRole role;

  221.     };

  222. 

  223.     //==============================================================================

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

  225.     {

  226.         jassert (role < 3);

  227. 

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

  229.         {

  230.             if (undoable)

  231.             {

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

  233.                                                "Change image resource");

  234.             }

  235.             else

  236.             {

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

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

  239.                 layout.changed();

  240.             }

  241.         }

  242.     }

  243. 

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

  245.     {

  246.         jassert (role < 3);

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

  248.     }

  249. 

  250.     //==============================================================================

  251.     class SetImageKeepsPropAction   : public ComponentUndoableAction<ImageButton>

  252.     {

  253.     public:

  254.         SetImageKeepsPropAction (ImageButton* const button,

  255.                                  ComponentLayout& layout_,

  256.                                  const bool newState_)

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

  258.               newState (newState_)

  259.         {

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

  261.         }

  262. 

  263.         bool perform() override

  264.         {

  265.             showCorrectTab();

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

  267.             return true;

  268.         }

  269. 

  270.         bool undo() override

  271.         {

  272.             showCorrectTab();

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

  274.             return true;

  275.         }

  276. 

  277.     private:

  278.         bool newState, oldState;

  279.     };

  280. 

  281.     static bool doesImageKeepProportions (ImageButton* button)

  282.     {

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

  284.     }

  285. 

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

  287.     {

  288.         if (undoable)

  289.         {

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

  291.         }

  292.         else

  293.         {

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

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

  296.             layout.changed();

  297.         }

  298.     }

  299. 

  300.     class ImageButtonProportionProperty    : public ComponentBooleanProperty<ImageButton>

  301.     {

  302.     public:

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

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

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

  306.               layout (layout_)

  307.         {

  308.         }

  309. 

  310.         void setState (bool newState)

  311.         {

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

  313.         }

  314. 

  315.         bool getState() const

  316.         {

  317.             return doesImageKeepProportions (component);

  318.         }

  319. 

  320.     private:

  321.         ComponentLayout& layout;

  322.     };

  323. 

  324.     //==============================================================================

  325.     class SetImageOpacityAction   : public ComponentUndoableAction<ImageButton>

  326.     {

  327.     public:

  328.         SetImageOpacityAction (ImageButton* const button,

  329.                                ComponentLayout& layout_,

  330.                                const ImageRole role_,

  331.                                const float newState_)

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

  333.               role (role_),

  334.               newState (newState_)

  335.         {

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

  337.         }

  338. 

  339.         bool perform() override

  340.         {

  341.             showCorrectTab();

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

  343.             return true;

  344.         }

  345. 

  346.         bool undo() override

  347.         {

  348.             showCorrectTab();

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

  350.             return true;

  351.         }

  352. 

  353.     private:

  354.         const ImageRole role;

  355.         float newState, oldState;

  356.     };

  357. 

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

  359.     {

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

  361.     }

  362. 

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

  364.     {

  365.         if (undoable)

  366.         {

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

  368.         }

  369.         else

  370.         {

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

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

  373.             layout.changed();

  374.         }

  375.     }

  376. 

  377.     class ImageButtonOpacityProperty    : public SliderPropertyComponent

  378.     {

  379.     public:

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

  381.                                     const String& name, const ImageRole role_)

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

  383.               owner (owner_),

  384.               layout (layout_),

  385.               role (role_)

  386.         {

  387.         }

  388. 

  389.         void setValue (double newValue) override

  390.         {

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

  392.         }

  393. 

  394.         double getValue() const override

  395.         {

  396.             return getImageOpacity (owner, role);

  397.         }

  398. 

  399.     private:

  400.         ImageButton* const owner;

  401.         ComponentLayout& layout;

  402.         const ImageRole role;

  403.     };

  404. 

  405.     //==============================================================================

  406.     class SetImageColourAction   : public ComponentUndoableAction<ImageButton>

  407.     {

  408.     public:

  409.         SetImageColourAction (ImageButton* const button,

  410.                               ComponentLayout& layout_,

  411.                               const ImageRole role_,

  412.                               Colour newState_)

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

  414.               role (role_),

  415.               newState (newState_)

  416.         {

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

  418.         }

  419. 

  420.         bool perform() override

  421.         {

  422.             showCorrectTab();

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

  424.             return true;

  425.         }

  426. 

  427.         bool undo() override

  428.         {

  429.             showCorrectTab();

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

  431.             return true;

  432.         }

  433. 

  434.     private:

  435.         const ImageRole role;

  436.         Colour newState, oldState;

  437.     };

  438. 

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

  440.     {

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

  442.     }

  443. 

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

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

  446.     {

  447.         if (undoable)

  448.         {

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

  450.         }

  451.         else

  452.         {

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

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

  455.             layout.changed();

  456.         }

  457.     }

  458. 

  459.     class ImageButtonColourProperty    : public JucerColourPropertyComponent,

  460.                                          public ChangeListener

  461.     {

  462.     public:

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

  464.                                    const String& name, const ImageRole role_)

  465.             : JucerColourPropertyComponent (name, false),

  466.               owner (owner_),

  467.               layout (layout_),

  468.               role (role_)

  469.         {

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

  471.         }

  472. 

  473.         ~ImageButtonColourProperty()

  474.         {

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

  476.         }

  477. 

  478.         void setColour (Colour newColour)

  479.         {

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

  481.         }

  482. 

  483.         Colour getColour() const

  484.         {

  485.             return getImageColour (owner, role);

  486.         }

  487. 

  488.         void resetToDefault() {}

  489. 

  490.         void changeListenerCallback (ChangeBroadcaster*)

  491.         {

  492.             refresh();

  493.         }

  494. 

  495.     private:

  496.         ImageButton* const owner;

  497.         ComponentLayout& layout;

  498.         const ImageRole role;

  499.     };

  500. 

  501.     //==============================================================================

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

  503.     {

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

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

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

  507. 

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

  509.                        norm,

  510.                        getImageOpacity (ib, normalImage),

  511.                        getImageColour (ib, normalImage),

  512.                        over,

  513.                        getImageOpacity (ib, overImage),

  514.                        getImageColour (ib, overImage),

  515.                        down,

  516.                        getImageOpacity (ib, downImage),

  517.                        getImageColour (ib, downImage));

  518.     }

  519. };