IAboutBoxControl.h File Reference

#include "IControls.h"

Go to the source code of this file.

Classes
class	IAboutBoxControl
	A "meta control" which you can attach child controls to display an about box, or preferences panel When you attach the control to the IGraphics context, it should be added last so it sits on top of other controls, and set hidden. More...

Detailed Description

A "meta control" which you can attach child controls to display an about box, or preferences panel When you attach the control to the IGraphics context, it should be added last so it sits on top of other controls, and set hidden.

You can then call Show() to reveal it. When the control is dismissed, there is no animation.

• Basic usage example:

  pGraphics->AttachControl(new IAboutBoxControl(b,
  COLOR_BLACK,
  // AttachFunc
  [](IContainerBase* pParent, const IRECT& r) {
    pParent->AddChildControl(new ITextControl(IRECT(), "MyPlugin", {DEFAULT_TEXT_SIZE * 5, COLOR_WHITE}));
    WDL_String versionStr {"Version "};
    versionStr.Append(PLUG_VERSION_STR);
    pParent->AddChildControl(new IVLabelControl(IRECT(), versionStr.Get()));
    pParent->AddChildControl(new IVLabelControl(IRECT(), "By Manufacturer"));
    pParent->AddChildControl(new IURLControl(IRECT(),
                                              "https://www.acmeinc.com",
                                              "https://www.acmeinc.com", {DEFAULT_TEXT_SIZE, COLOR_WHITE}));
  },
  // ResizeFunc
  [](IContainerBase* pParent, const IRECT& r) {
    const IRECT mainArea = r.GetPadded(-20);
    const auto content = mainArea.GetPadded(-10);
    const auto logo = content.GetFromTop(300).GetCentredInside(300, 100);
    const auto links = content.FracRectVertical(0.75).GetCentredInside(300, 100);
    pParent->GetChild(0)->SetTargetAndDrawRECTs(logo);
    pParent->GetChild(1)->SetTargetAndDrawRECTs(links.SubRectVertical(4, 0));
    pParent->GetChild(2)->SetTargetAndDrawRECTs(links.SubRectVertical(4, 2));
    pParent->GetChild(3)->SetTargetAndDrawRECTs(links.SubRectVertical(4, 3));
  }, 200), kCtrlTagAboutBox)->Hide(true);

  In a button control somewhere on the UI, call pGraphics->GetControlWithTag(kCtrlTagAboutBox)->As<IAboutBoxControl>()->Show(); in order to get the about box to appear.

Definition in file IAboutBoxControl.h.