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.
13539 Commits
11 Branches
891MB
Tree: db90a31813
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'db90a31813'
${ noResults }
JUCE/extras/Projucer/Source/ComponentEditor/Components/jucer_ImageButtonHandler.h

527 lines
19KB
Raw Blame History 

  1. /*

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

  3. 

  4.    This file is part of the JUCE library.

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

  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 7 End-User License

  11.    Agreement and JUCE Privacy Policy.

  12. 

  13.    End User License Agreement: www.juce.com/juce-7-licence

  14.    Privacy Policy: www.juce.com/juce-privacy-policy

  15. 

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

  17.    www.gnu.org/licenses).

  18. 

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

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

  21.    DISCLAIMED.

  22. 

  23.   ==============================================================================

  24. */

  25. 

  26. #pragma once

  27. 

  28. 

  29. //==============================================================================

  30. class ImageButtonHandler  : public ButtonHandler

  31. {

  32. public:

  33.     enum ImageRole

  34.     {

  35.         normalImage = 0,

  36.         overImage = 1,

  37.         downImage = 2

  38.     };

  39. 

  40.     //==============================================================================

  41.     ImageButtonHandler()

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

  43.     {

  44.     }

  45. 

  46.     Component* createNewComponent (JucerDocument*) override

  47.     {

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

  49.     }

  50. 

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

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

  53.     {

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

  55. 

  56.         if (multipleSelected)

  57.             return;

  58. 

  59.         addColourProperties (component, document, props);

  60. 

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

  62.         {

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

  64. 

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

  66. 

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

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

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

  70. 

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

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

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

  74. 

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

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

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

  78.         }

  79.     }

  80. 

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

  82.     {

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

  84. 

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

  86. 

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

  88. 

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

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

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

  92. 

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

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

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

  96. 

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

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

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

  100. 

  101.         return e;

  102.     }

  103. 

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

  105.     {

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

  107.             return false;

  108. 

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

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

  111. 

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

  113. 

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

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

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

  117. 

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

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

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

  121. 

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

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

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

  125. 

  126.         return true;

  127.     }

  128. 

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

  130.     {

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

  132. 

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

  134. 

  135.         String s;

  136. 

  137.         s << getColourIntialisationCode (component, memberVariableName)

  138.           << '\n';

  139. 

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

  141. 

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

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

  144.           << indent

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

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

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

  148.           << indent

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

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

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

  152.           << indent

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

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

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

  156.           << ");\n";

  157. 

  158.         code.constructorCode += s;

  159.     }

  160. 

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

  162.     {

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

  164. 

  165.         if (resName.isEmpty())

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

  167. 

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

  169.     }

  170. 

  171.     //==============================================================================

  172.     class ImageButtonResourceProperty    : public ImageResourceProperty<ImageButton>

  173.     {

  174.     public:

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

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

  177.               role (role_),

  178.               layout (layout_)

  179.         {

  180.         }

  181. 

  182.         void setResource (const String& newName)

  183.         {

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

  185.         }

  186. 

  187.         String getResource() const

  188.         {

  189.             return getImageResource (element, role);

  190.         }

  191. 

  192.     private:

  193.         const ImageRole role;

  194.         ComponentLayout& layout;

  195.     };

  196. 

  197.     class SetImageResourceAction   : public ComponentUndoableAction<ImageButton>

  198.     {

  199.     public:

  200.         SetImageResourceAction (ImageButton* const button,

  201.                                 ComponentLayout& layout_,

  202.                                 const ImageRole role_,

  203.                                 const String& newResource_)

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

  205.               newResource (newResource_),

  206.               role (role_)

  207.         {

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

  209.         }

  210. 

  211.         bool perform() override

  212.         {

  213.             showCorrectTab();

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

  215.             return true;

  216.         }

  217. 

  218.         bool undo() override

  219.         {

  220.             showCorrectTab();

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

  222.             return true;

  223.         }

  224. 

  225.     private:

  226.         String newResource, oldResource;

  227.         const ImageRole role;

  228.     };

  229. 

  230.     //==============================================================================

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

  232.     {

  233.         jassert (role < 3);

  234. 

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

  236.         {

  237.             if (undoable)

  238.             {

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

  240.                                                "Change image resource");

  241.             }

  242.             else

  243.             {

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

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

  246.                 layout.changed();

  247.             }

  248.         }

  249.     }

  250. 

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

  252.     {

  253.         jassert (role < 3);

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

  255.     }

  256. 

  257.     //==============================================================================

  258.     class SetImageKeepsPropAction   : public ComponentUndoableAction<ImageButton>

  259.     {

  260.     public:

  261.         SetImageKeepsPropAction (ImageButton* const button,

  262.                                  ComponentLayout& layout_,

  263.                                  const bool newState_)

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

  265.               newState (newState_)

  266.         {

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

  268.         }

  269. 

  270.         bool perform() override

  271.         {

  272.             showCorrectTab();

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

  274.             return true;

  275.         }

  276. 

  277.         bool undo() override

  278.         {

  279.             showCorrectTab();

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

  281.             return true;

  282.         }

  283. 

  284.     private:

  285.         bool newState, oldState;

  286.     };

  287. 

  288.     static bool doesImageKeepProportions (ImageButton* button)

  289.     {

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

  291.     }

  292. 

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

  294.     {

  295.         if (undoable)

  296.         {

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

  298.         }

  299.         else

  300.         {

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

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

  303.             layout.changed();

  304.         }

  305.     }

  306. 

  307.     class ImageButtonProportionProperty    : public ComponentBooleanProperty<ImageButton>

  308.     {

  309.     public:

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

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

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

  313.               layout (layout_)

  314.         {

  315.         }

  316. 

  317.         void setState (bool newState)

  318.         {

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

  320.         }

  321. 

  322.         bool getState() const

  323.         {

  324.             return doesImageKeepProportions (component);

  325.         }

  326. 

  327.     private:

  328.         ComponentLayout& layout;

  329.     };

  330. 

  331.     //==============================================================================

  332.     class SetImageOpacityAction   : public ComponentUndoableAction<ImageButton>

  333.     {

  334.     public:

  335.         SetImageOpacityAction (ImageButton* const button,

  336.                                ComponentLayout& layout_,

  337.                                const ImageRole role_,

  338.                                const float newState_)

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

  340.               role (role_),

  341.               newState (newState_)

  342.         {

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

  344.         }

  345. 

  346.         bool perform() override

  347.         {

  348.             showCorrectTab();

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

  350.             return true;

  351.         }

  352. 

  353.         bool undo() override

  354.         {

  355.             showCorrectTab();

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

  357.             return true;

  358.         }

  359. 

  360.     private:

  361.         const ImageRole role;

  362.         float newState, oldState;

  363.     };

  364. 

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

  366.     {

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

  368.     }

  369. 

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

  371.     {

  372.         if (undoable)

  373.         {

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

  375.         }

  376.         else

  377.         {

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

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

  380.             layout.changed();

  381.         }

  382.     }

  383. 

  384.     class ImageButtonOpacityProperty    : public SliderPropertyComponent

  385.     {

  386.     public:

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

  388.                                     const String& name, const ImageRole role_)

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

  390.               owner (owner_),

  391.               layout (layout_),

  392.               role (role_)

  393.         {

  394.         }

  395. 

  396.         void setValue (double newValue) override

  397.         {

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

  399.         }

  400. 

  401.         double getValue() const override

  402.         {

  403.             return getImageOpacity (owner, role);

  404.         }

  405. 

  406.     private:

  407.         ImageButton* const owner;

  408.         ComponentLayout& layout;

  409.         const ImageRole role;

  410.     };

  411. 

  412.     //==============================================================================

  413.     class SetImageColourAction   : public ComponentUndoableAction<ImageButton>

  414.     {

  415.     public:

  416.         SetImageColourAction (ImageButton* const button,

  417.                               ComponentLayout& layout_,

  418.                               const ImageRole role_,

  419.                               Colour newState_)

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

  421.               role (role_),

  422.               newState (newState_)

  423.         {

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

  425.         }

  426. 

  427.         bool perform() override

  428.         {

  429.             showCorrectTab();

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

  431.             return true;

  432.         }

  433. 

  434.         bool undo() override

  435.         {

  436.             showCorrectTab();

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

  438.             return true;

  439.         }

  440. 

  441.     private:

  442.         const ImageRole role;

  443.         Colour newState, oldState;

  444.     };

  445. 

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

  447.     {

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

  449.     }

  450. 

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

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

  453.     {

  454.         if (undoable)

  455.         {

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

  457.         }

  458.         else

  459.         {

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

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

  462.             layout.changed();

  463.         }

  464.     }

  465. 

  466.     class ImageButtonColourProperty    : public JucerColourPropertyComponent,

  467.                                          private ChangeListener

  468.     {

  469.     public:

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

  471.                                    const String& name, const ImageRole role_)

  472.             : JucerColourPropertyComponent (name, false),

  473.               owner (owner_),

  474.               layout (layout_),

  475.               role (role_)

  476.         {

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

  478.         }

  479. 

  480.         ~ImageButtonColourProperty() override

  481.         {

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

  483.         }

  484. 

  485.         void setColour (Colour newColour) override

  486.         {

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

  488.         }

  489. 

  490.         Colour getColour() const override

  491.         {

  492.             return getImageColour (owner, role);

  493.         }

  494. 

  495.         void resetToDefault() override {}

  496. 

  497.     private:

  498.         void changeListenerCallback (ChangeBroadcaster*) override

  499.         {

  500.             refresh();

  501.         }

  502. 

  503.         ImageButton* const owner;

  504.         ComponentLayout& layout;

  505.         const ImageRole role;

  506.     };

  507. 

  508.     //==============================================================================

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

  510.     {

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

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

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

  514. 

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

  516.                        norm,

  517.                        getImageOpacity (ib, normalImage),

  518.                        getImageColour (ib, normalImage),

  519.                        over,

  520.                        getImageOpacity (ib, overImage),

  521.                        getImageColour (ib, overImage),

  522.                        down,

  523.                        getImageOpacity (ib, downImage),

  524.                        getImageColour (ib, downImage));

  525.     }

  526. };