API — ICoreSDK/ICoreStudio/StudioObjects/Panels/Diagnostics

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

ICoreJobNotifier.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Diagnostics/ICoreJobNotifier.h

ICoreJobNotifier#

ICoreJobNotifier.h:20 · class · 1 declaration(s)

Tiny GUI-thread notifier that broadcasts when a background verification/export job starts and ends, so UI surfaces (deploy table, target config panels, action buttons) can lock/unlock themselves wh...

class ICoreJobNotifier {
public:
    static ICoreJobNotifier* instance();

    ICoreSignal<> jobStarted;
    ICoreSignal<> jobEnded;

};

ICoreLoggerTextBox.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Diagnostics/ICoreLoggerTextBox.h

ICoreLoggerTextBox#

ICoreLoggerTextBox.h:17 · class · bases public ICoreRichTextEdit, public ICoreLogSink · pImpl · 8 declaration(s)

The view onto an ICoreLoggerObject.

class ICoreLoggerTextBox : public ICoreRichTextEdit, public ICoreLogSink {
public:
    explicit ICoreLoggerTextBox(ICoreLoggerObject* parentLogger);

    ~ICoreLoggerTextBox() override;

    // ICoreLogSink -- called on the logging thread, for both live lines and
    // the history replayed during attachSink().
    void onLogLine(const std::string& line) override;

    // --- Transcript text size, in points -----------------------------------
    // The zoom the Script Runner gives its editor, pointed at a log pane:
    // resizes the widget font AND the document's default font, so lines
    // already appended resize with the ones still to come. Appended markup
    // names a family but never a size, which is what makes that work.
    //
    // Driven by a panel's "A-  13pt  A+" toolbar (the Quick Code console), and
    // by Ctrl+wheel / Ctrl+ +/-/0 over the pane itself.
    //
    // The baseline Ctrl+0 restores is the font this pane was given at
    // construction -- set one through setBaseFont() rather than setFont() when
    // the pane is meant to be zoomable, otherwise the owner's font is measured
    // as a zoom step away from the inherited one.
    void setBaseFont(const ICoreFont& font);

    [[nodiscard]] int logFontSize() const;
    [[nodiscard]] int defaultLogFontSize() const;
    void setLogFontSize(int points);

    static constexpr int MIN_FONT_POINTS = 7;
    static constexpr int MAX_FONT_POINTS = 32;

    // Fires on every accepted size change, whichever of the three gestures
    // caused it -- a toolbar readout subscribes here rather than assuming its
    // own buttons are the only way the size moves.
    ICoreSignal<int> onLogFontSizeChanged;

protected:
    void paintOverlay(ICorePainter& painter, const ICoreRect& bounds) override;
    bool keyPressed(const ICoreKeyEvent& event) override;      // Ctrl+ +/-/0
    bool wheelScrolled(const ICoreWheelEvent& event) override; // Ctrl+wheel

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreRunDiagnosisBroadcaster.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Diagnostics/ICoreRunDiagnosisBroadcaster.h

ICoreRunDiagnosisBroadcaster#

ICoreRunDiagnosisBroadcaster.h:10 · class · 2 declaration(s)

class ICoreRunDiagnosisBroadcaster {
public:
    static ICoreRunDiagnosisBroadcaster* instance();

    // Thread-safe: safe to call from any thread
    static void dispatch(const ICoreString& message, int level); // 0=log, 1=warning, 2=error
    static void clearLog();

    // Always delivered on the GUI thread: dispatch()/clearLog() go through the
    // queued ICoreSignal::post hop, whatever thread they were called from.
    ICoreSignal<ICoreString, int> logAppended;   // (message, level)
    ICoreSignal<> alertRaised;                   // raised for level >= 1 (warning or error)
    ICoreSignal<> clearRequested;

};

ICoreRunDiagnosisPanel.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Diagnostics/ICoreRunDiagnosisPanel.h

ICoreRunDiagnosisPanel#

ICoreRunDiagnosisPanel.h:19 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

class ICoreRunDiagnosisPanel : public ICoreWidget {
public:
    explicit ICoreRunDiagnosisPanel(ICoreWidget* parent = nullptr);
    ~ICoreRunDiagnosisPanel() override;

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};