Slic3r::GUI::WikiLabel Class Reference

Inheritance diagram for Slic3r::GUI::WikiLabel:

Collaboration diagram for Slic3r::GUI::WikiLabel:

Public Member Functions
	WikiLabel (wxWindow *parent, const wxString &label, const wxString &url=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
void	SetLabel (const wxString &label) override
bool	SetFont (const wxFont &font) override
wxString	GetLabel () const override
void	SetURL (const wxString &url)
wxString	GetURL () const
void	ReflowText ()
wxSize	DoGetBestSize () const override
void	Rescale ()

Private Member Functions
void	OnPaint (wxPaintEvent &evt)
void	OnSize (wxSizeEvent &evt)
void	OnMotion (wxMouseEvent &evt)
void	OnLeaveWin (wxMouseEvent &evt)
void	OnLeftDown (wxMouseEvent &evt)

Private Attributes
wxString	m_label
wxString	m_url
wxArrayString	m_lines
bool	m_hovered = false
wxFont	m_font
int	m_last_wrap_width = -1

Detailed Description

Constructor & Destructor Documentation

WikiLabel()

Slic3r::GUI::WikiLabel::WikiLabel ( wxWindow * parent, const wxString & label, const wxString & url = wxEmptyString, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize )

inline

        : wxPanel(parent, wxID_ANY, pos, size, wxFULL_REPAINT_ON_RESIZE)
        , m_label(label)
        , m_url(url)
    {
#ifndef __WXOSX__ 
        SetDoubleBuffered(true);// SetDoubleBuffered exists on Win and Linux/GTK, but is missing on OSX
#endif
        SetBackgroundColour(parent->GetBackgroundColour());
 
        SetFont(Label::Body_14);
 
        Bind(wxEVT_PAINT,        &WikiLabel::OnPaint, this);
        Bind(wxEVT_SIZE,         &WikiLabel::OnSize, this);
        Bind(wxEVT_MOTION,       &WikiLabel::OnMotion, this);
        Bind(wxEVT_LEAVE_WINDOW, &WikiLabel::OnLeaveWin, this);
        Bind(wxEVT_LEFT_DOWN,    &WikiLabel::OnLeftDown, this);
    }

References Label::Body_14, m_label, m_url, OnLeaveWin(), OnLeftDown(), OnMotion(), OnPaint(), OnSize(), and SetFont().

Here is the call graph for this function:

Member Function Documentation

DoGetBestSize()

wxSize Slic3r::GUI::WikiLabel::DoGetBestSize ( ) const

inlineoverride

    {
        const int lineH  = wxMax(1, wxWindow::GetCharHeight()); // GTK can return 0 from GetCharHeight() before the window is realized
        const int nLines = m_lines.IsEmpty() ? 1 : static_cast<int>(m_lines.size());
        const int totalH = static_cast<int>(nLines * lineH * 1.3);
 
        const int clientW = GetClientSize().GetWidth();
 
        if (clientW > 0)
            return wxSize(clientW, totalH);
 
        if (m_label.IsEmpty())
            return wxSize(1, lineH);
 
        int maxW = 0;
        for (const wxString& line : wxSplit(m_label, '\n'))
            maxW = wxMax(maxW, GetTextExtent(line).GetWidth());
 
        return wxSize(wxMax(1, maxW), totalH);
    }

References m_label, and m_lines.

GetLabel()

wxString Slic3r::GUI::WikiLabel::GetLabel ( ) const

inlineoverride

{ return m_label; }

References m_label.

GetURL()

wxString Slic3r::GUI::WikiLabel::GetURL ( ) const

inline

{ return m_url; }

References m_url.

OnLeaveWin()

void Slic3r::GUI::WikiLabel::OnLeaveWin ( wxMouseEvent & evt )

inlineprivate

    {
        if(!m_url.IsEmpty() && m_hovered){
            m_hovered = false;
            Refresh();
        }
        evt.Skip();
    }

References m_hovered, m_url, and Slic3r::GUI::wxMouseEvent.

Referenced by WikiLabel().

Here is the caller graph for this function:

OnLeftDown()

void Slic3r::GUI::WikiLabel::OnLeftDown ( wxMouseEvent & evt )

inlineprivate

    {
        if (!m_url.IsEmpty())
            wxLaunchDefaultBrowser(m_url);
        evt.Skip();
    } 

References m_url, and Slic3r::GUI::wxMouseEvent.

Referenced by WikiLabel().

Here is the caller graph for this function:

OnMotion()

void Slic3r::GUI::WikiLabel::OnMotion ( wxMouseEvent & evt )

inlineprivate

    {
        if(!m_url.IsEmpty() && !m_hovered){
            m_hovered = true;
            Refresh();
        }
        evt.Skip();
    }

References m_hovered, m_url, and Slic3r::GUI::wxMouseEvent.

Referenced by WikiLabel().

Here is the caller graph for this function:

OnPaint()

void Slic3r::GUI::WikiLabel::OnPaint ( wxPaintEvent & evt )

inlineprivate

    {
        wxPaintDC dc(this);
 
        dc.SetBackground(wxBrush(GetParent() ? GetParent()->GetBackgroundColour() : *wxWHITE));
        dc.Clear();
 
        wxColour textCol = StateColor::darkModeColorFor(m_hovered ? "#26A69A" : "#363636");
 
        dc.SetTextForeground(textCol);
        dc.SetFont(m_font);
        dc.SetBackgroundMode(wxTRANSPARENT);
 
        int lineH = dc.GetCharHeight();
        int y     = lround(lineH * 0.15);
 
        for (const wxString& line : m_lines) {
            if (!line.IsEmpty()) {
                dc.DrawText(line, 0, y);
 
                if (m_hovered) {
                    int tw, th;
                    dc.GetTextExtent(line, &tw, &th);
 
                    int underlineY = y + lineH - 1; // 1 px below the baseline
                    dc.SetPen(wxPen(textCol, 1));
                    dc.DrawLine(0, underlineY, tw, underlineY);
                }
            }
            y += lineH;
        }
    }

References StateColor::darkModeColorFor(), m_font, m_hovered, and m_lines.

Referenced by WikiLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSize()

void Slic3r::GUI::WikiLabel::OnSize ( wxSizeEvent & evt )

inlineprivate

    {
        ReflowText();
        Refresh();
        evt.Skip();
    }

References ReflowText().

Referenced by WikiLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

ReflowText()

void Slic3r::GUI::WikiLabel::ReflowText ( )

inline

    {
        const int clientW = GetClientSize().GetWidth();
 
        if (clientW <= 0 || (clientW == m_last_wrap_width && !m_lines.IsEmpty()))
            return;
 
        m_last_wrap_width = clientW;
 
        wxArrayString lines;
        for (const wxString& para : wxSplit(m_label, '\n')) {
            if (para.IsEmpty())
                lines.Add(wxEmptyString);
            else {
                wxString currentLine;
                for (const wxString& word : wxSplit(para, ' ')) {
                    wxString candidate = currentLine.IsEmpty() ? word : (currentLine + ' ' + word);
 
                    if (GetTextExtent(candidate).GetWidth() <= clientW)
                        currentLine = candidate;
                    else {
                        if (currentLine.IsEmpty())
                            lines.Add(word); // single word wider than column
                        else {
                            lines.Add(currentLine);
                            currentLine = word;
                        }
                    }
                }
                if (!currentLine.IsEmpty())
                    lines.Add(currentLine);
            }
        }
        m_lines = lines;
 
        const int lineH  = wxMax(1, wxWindow::GetCharHeight()); // GTK can return 0 from GetCharHeight() before the window is realized
        const int nLines = m_lines.IsEmpty() ? 1 : static_cast<int>(m_lines.size());
        const int totalH = static_cast<int>(nLines * lineH * 1.3);
 
        SetMinSize(wxSize(-1, totalH));
        InvalidateBestSize();
    }

References m_label, m_last_wrap_width, and m_lines.

Referenced by OnSize(), SetFont(), and SetLabel().

Here is the caller graph for this function:

Rescale()

void Slic3r::GUI::WikiLabel::Rescale ( )

inline

    {
        m_last_wrap_width = -1; // force re-wrap
        m_lines.Clear();
        InvalidateBestSize();
    }

References m_last_wrap_width, and m_lines.

SetFont()

bool Slic3r::GUI::WikiLabel::SetFont ( const wxFont & font )

inlineoverride

    {
        const bool changed = wxPanel::SetFont(font);
        m_font = font;
        m_last_wrap_width = -1; // force re-wrap
        if (IsShownOnScreen()) {
            ReflowText();
            Refresh();
        }
        return changed;
    }

References m_font, m_last_wrap_width, and ReflowText().

Referenced by WikiLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLabel()

void Slic3r::GUI::WikiLabel::SetLabel ( const wxString & label )

inlineoverride

    {
        m_label = label;
        m_last_wrap_width = -1; // force re-wrap
        ReflowText();
        Refresh();
    }

References m_label, m_last_wrap_width, and ReflowText().

Here is the call graph for this function:

SetURL()

void Slic3r::GUI::WikiLabel::SetURL ( const wxString & url )

inline

{ m_url = url; }

References m_url.

Member Data Documentation

m_font

wxFont Slic3r::GUI::WikiLabel::m_font

private

Referenced by OnPaint(), and SetFont().

m_hovered

bool Slic3r::GUI::WikiLabel::m_hovered = false

private

Referenced by OnLeaveWin(), OnMotion(), and OnPaint().

m_label

wxString Slic3r::GUI::WikiLabel::m_label

private

Referenced by WikiLabel(), DoGetBestSize(), GetLabel(), ReflowText(), and SetLabel().

m_last_wrap_width

int Slic3r::GUI::WikiLabel::m_last_wrap_width = -1

private

Referenced by ReflowText(), Rescale(), SetFont(), and SetLabel().

m_lines

wxArrayString Slic3r::GUI::WikiLabel::m_lines

private

Referenced by DoGetBestSize(), OnPaint(), ReflowText(), and Rescale().

m_url

wxString Slic3r::GUI::WikiLabel::m_url

private

Referenced by WikiLabel(), GetURL(), OnLeaveWin(), OnLeftDown(), OnMotion(), and SetURL().

---

The documentation for this class was generated from the following file:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Preferences.cpp