Generated reference › API — ICoreBlocks/ICoreStudio/StudioObjects/Panels
kind: generated#api#icoreblocks-icorestudio-studioobjects-panels

API — ICoreBlocks/ICoreStudio/StudioObjects/Panels

The public contract of 1 header(s) under src/ICoreBlocks/ICoreStudio/StudioObjects/Panels — 1 class/struct definition(s), 1 declaration(s). Each section shows the header's banner and its public (and protected-virtual) surface exactly as the file writes it.

HeaderDefinesDeclarationsBases
ICoreBannerStrip.hICoreBannerStrip1—

ICoreBannerStrip.h#

src/ICoreBlocks/ICoreStudio/StudioObjects/Panels/ICoreBannerStrip.h

ICoreBannerStrip#

ICoreBannerStrip.h:32 · class · 1 declaration(s)

ICoreBannerStrip — the one drawing of a notice strip across the top of the editor, shared by every banner the application has.

class ICoreBannerStrip {
public:
    ICoreBannerStrip() = delete;

    enum class Tone { Notice, Warning, Danger };

    // One line of body text plus a button, at every density. Fixed so a host
    // laying out the window can reserve the space without instantiating one.
    static constexpr int HEIGHT = 44;

    // Left inset of the text, past the accent edge.
    static constexpr int TEXT_LEFT = 17;

    // Paints ground, wash, accent edge, bottom hairline and the sentence,
    // elided into whatever `reservedRight` pixels of buttons leave.
    static void paint(ICorePainter& painter, int width, int height, Tone tone,
                      const ICoreString& text, int reservedRight);
};
};