RadioGroup Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/RadioGroup.hpp>

Inheritance diagram for RadioGroup:

Collaboration diagram for RadioGroup:

Public Member Functions
	RadioGroup ()
	RadioGroup (wxWindow *parent, const std::vector< wxString > &labels={"1", "2", "3"}, long direction=wxHORIZONTAL, int row_col_limit=-1)
void	Create (wxWindow *parent, const std::vector< wxString > &labels={"1", "2", "3"}, long direction=wxHORIZONTAL, int row_col_limit=-1)
int	GetSelection ()
void	SetSelection (int index, bool focus=false)
void	SelectNext (bool focus=true)
void	SelectPrevious (bool focus=true)
bool	Enable (bool enable=true) override
bool	IsEnabled ()
bool	Disable ()
void	SetRadioTooltip (int i, wxString tooltip)

Private Member Functions
void	SetRadioIcon (int i, bool hover)

Private Attributes
std::vector< wxString >	m_labels
std::vector< wxStaticBitmap * >	m_radioButtons
std::vector< Button * >	m_labelButtons
int	m_selectedIndex
int	m_item_count
bool	m_focused
bool	m_enabled
StateColor	m_focus_color
StateColor	m_text_color
ScalableBitmap	m_on
ScalableBitmap	m_off
ScalableBitmap	m_on_hover
ScalableBitmap	m_off_hover
ScalableBitmap	m_disabled

Detailed Description

Constructor & Destructor Documentation

RadioGroup() [1/2]

RadioGroup::RadioGroup

(

)

RadioGroup() [2/2]

RadioGroup::RadioGroup	(	wxWindow *	parent,
		const std::vector< wxString > &	labels = {"1", "2", "3"},
		long	direction = wxHORIZONTAL,
		int	row_col_limit = -1 )

    : wxPanel(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxNO_BORDER) // ensure wxTAB_TRAVERSAL not applied by default
    , m_on(       this, "radio_on"       , 18)
    , m_off(      this, "radio_off"      , 18)
    , m_on_hover( this, "radio_on_hover" , 18)
    , m_off_hover(this, "radio_off_hover", 18)
    , m_disabled( this, "radio_disabled" , 18)
    , m_selectedIndex(0)
    , m_focused(false)
    , m_enabled(true)
{
    Create(parent, labels, direction, row_col_limit);
}

References Create(), m_disabled, m_enabled, m_focused, m_off, m_off_hover, m_on, m_on_hover, and m_selectedIndex.

Here is the call graph for this function:

Member Function Documentation

Create()

void RadioGroup::Create	(	wxWindow *	parent,
		const std::vector< wxString > &	labels = {"1", "2", "3"},
		long	direction = wxHORIZONTAL,
		int	row_col_limit = -1 )

{
    m_labels = labels;
    m_item_count = m_labels.size();
 
    auto bg = parent->GetBackgroundColour();
    this->SetBackgroundColour(bg);
 
    m_text_color = StateColor(
        std::pair(wxColour("#6B6A6A"), (int)StateColor::Disabled),
        std::pair(wxColour("#363636"), (int)StateColor::Enabled)
    );
 
    m_focus_color = StateColor(
        std::pair(bg                 , (int)StateColor::NotFocused),
        std::pair(wxColour("#009688"), (int)StateColor::Focused)
    );
 
    auto bmp_size   = m_on.GetBmpSize();
    int  item_limit = row_col_limit < 0 ? 1 : row_col_limit > m_item_count ? m_item_count : row_col_limit;
    int  count      = (int(m_item_count / item_limit) + (m_item_count % item_limit));
    int  rows       = (direction & wxHORIZONTAL) ? item_limit : count;
    int  cols       = (direction & wxHORIZONTAL) ? count : item_limit;
    wxFlexGridSizer* f_sizer = new wxFlexGridSizer(rows, cols, 0, 0);
 
    SetDoubleBuffered(true);
 
    for (int i = 0; i < m_item_count; ++i){
        auto rb = new wxStaticBitmap(this, wxID_ANY, m_off.bmp(), wxDefaultPosition, wxDefaultSize, wxBU_LEFT | wxNO_BORDER);
        m_radioButtons.push_back(rb);
        rb->Bind(wxEVT_LEFT_DOWN   ,([this, i](wxMouseEvent e) {SetSelection(i, true) ; e.Skip();}));
        rb->Bind(wxEVT_ENTER_WINDOW,([this, i](wxMouseEvent e) {SetRadioIcon(i, true) ; e.Skip();}));
        rb->Bind(wxEVT_LEAVE_WINDOW,([this, i](wxMouseEvent e) {
            // prevent removing hover effect while switching between button and its text
            auto win = wxFindWindowAtPoint(wxGetMousePosition());
            if(!win || win->GetId() != m_labelButtons[i]->GetId())
                SetRadioIcon(i, false);
            e.Skip();
        }));
 
        auto tx = new Button(this, m_labels[i]);
        if(i != 0) // one focusable control must exist. wxPanel starts taking focus if there is no focusable control
            tx->SetCanFocus(false);
        tx->SetPaddingSize(FromDIP(wxSize(5,2)));
        tx->SetBackgroundColor(bg);
        tx->SetCornerRadius(0);
        tx->SetBorderWidth(FromDIP(1));
        tx->SetBorderColor(m_focus_color);
        tx->SetFont(Label::Body_14);
        tx->SetTextColor(m_text_color);
        tx->Bind(wxEVT_BUTTON      ,([this, i](wxCommandEvent e) {SetSelection(i, true) ; e.Skip();}));
        tx->Bind(wxEVT_ENTER_WINDOW,([this, i](wxMouseEvent   e) {SetRadioIcon(i, true) ; e.Skip();}));
        tx->Bind(wxEVT_LEAVE_WINDOW,([this, i](wxMouseEvent   e) {
            // prevent removing hover effect while switching between button and its text
            auto win = wxFindWindowAtPoint(wxGetMousePosition());
            if(!win || win->GetId() != m_radioButtons[i]->GetId())
                SetRadioIcon(i, false);
            e.Skip();
        }));
        tx->Bind(wxEVT_CHAR_HOOK, ([this, tx](wxKeyEvent&e){
            if(tx->HasFocus()){
                int  k = e.GetKeyCode();
                bool is_next = (k == WXK_DOWN || k == WXK_RIGHT);
                bool is_prev = (k == WXK_LEFT || k == WXK_UP);
                if      (is_next) SelectNext();
                else if (is_prev) SelectPrevious();
                e.Skip(!(is_next || is_prev));
            }else{
                e.Skip();
            }
        }));
        m_labelButtons.push_back(tx);
 
        wxBoxSizer* radio_sizer = new wxBoxSizer(wxHORIZONTAL);
        radio_sizer->Add(rb, 0, wxALIGN_CENTER_VERTICAL);
        radio_sizer->Add(tx, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, this->FromDIP(10));
        f_sizer->Add(radio_sizer, 0, wxTOP | wxBOTTOM, this->FromDIP(4));
    }
    SetSelection(m_selectedIndex);
    SetSizer(f_sizer);
}

References Label::Body_14, count, StateColor::Disabled, StateColor::Enabled, StateColor::Focused, m_focus_color, m_item_count, m_labelButtons, m_labels, m_off, m_on, m_radioButtons, m_selectedIndex, m_text_color, StateColor::NotFocused, SelectNext(), SelectPrevious(), SetRadioIcon(), and SetSelection().

Referenced by RadioGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

Disable()

bool RadioGroup::Disable

(

)

{return RadioGroup::Enable(false);};

References Enable().

Here is the call graph for this function:

Enable()

bool RadioGroup::Enable ( bool enable = true )

override

{
    m_enabled = enable;
    bool result = wxPanel::Enable(enable);
 
    if (result) {
        for (size_t i = 0; i < m_item_count; ++i){
            SetRadioIcon(i, false);
            m_labelButtons[i]->Enable(enable); // normally disabling parent should do this but not
        }
 
        wxCommandEvent e(EVT_ENABLE_CHANGED);
        e.SetEventObject(this);
        GetEventHandler()->ProcessEvent(e);
    }
 
    return result;
};

References m_enabled, m_item_count, m_labelButtons, and SetRadioIcon().

Referenced by Disable().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSelection()

int RadioGroup::GetSelection

(

)

{ 
    return m_selectedIndex; 
}

References m_selectedIndex.

IsEnabled()

bool RadioGroup::IsEnabled

(

)

{return m_enabled;};

References m_enabled.

SelectNext()

void RadioGroup::SelectNext

(

bool

focus = true

)

{
    SetSelection(m_selectedIndex + 1 > (m_radioButtons.size() - 1) ? 0 : m_selectedIndex + 1, focus);
}

References m_radioButtons, m_selectedIndex, and SetSelection().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectPrevious()

void RadioGroup::SelectPrevious

(

bool

focus = true

)

{
    SetSelection(m_selectedIndex - 1 < 0 ? (m_radioButtons.size() - 1) : m_selectedIndex - 1, focus);
}

References m_radioButtons, m_selectedIndex, and SetSelection().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

SetRadioIcon()

void RadioGroup::SetRadioIcon ( int i, bool hover )

private

{
    auto icon = !m_enabled ? m_disabled : m_selectedIndex == i ? (hover ? m_on_hover : m_on) : (hover ? m_off_hover : m_off);
    m_radioButtons[i]->SetBitmap(icon.bmp());
}

References m_disabled, m_enabled, m_off, m_off_hover, m_on, m_on_hover, m_radioButtons, and m_selectedIndex.

Referenced by Create(), Enable(), and SetSelection().

Here is the caller graph for this function:

SetRadioTooltip()

void RadioGroup::SetRadioTooltip	(	int	i,
		wxString	tooltip )

{
    m_radioButtons[i]->SetToolTip(tooltip);
    m_labelButtons[i]->SetToolTip(tooltip);
}

References m_labelButtons, and m_radioButtons.

Referenced by Slic3r::GUI::PreferencesDialog::create_debug_page().

Here is the caller graph for this function:

SetSelection()

void RadioGroup::SetSelection	(	int	index,
		bool	focus = false )

{
    if (index >= 0 && index < m_item_count){
        int prev_index = m_selectedIndex;
        if(index != prev_index){ // prevent no focusable item on first creation. wxPanel starts taking focus if there is no focusable control
            m_labelButtons[index]->SetCanFocus(true);
            m_labelButtons[prev_index]->SetCanFocus(false);
        }
        if(focus)
            m_labelButtons[index]->SetFocus();
        m_selectedIndex = index;
        for (size_t i = 0; i < m_item_count; ++i)
            SetRadioIcon(i, m_labelButtons[index]->HasFocus() && i == m_selectedIndex);
 
        wxCommandEvent evt(wxEVT_COMMAND_RADIOBOX_SELECTED, GetId());
        evt.SetInt(index);
        evt.SetString(m_labels[index]);
        GetEventHandler()->ProcessEvent(evt);
    }
}

References m_item_count, m_labelButtons, m_labels, m_selectedIndex, and SetRadioIcon().

Referenced by Slic3r::GUI::ProjectDropDialog::ProjectDropDialog(), Create(), SelectNext(), and SelectPrevious().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_disabled

ScalableBitmap RadioGroup::m_disabled

private

Referenced by RadioGroup(), and SetRadioIcon().

m_enabled

bool RadioGroup::m_enabled

private

Referenced by RadioGroup(), Enable(), IsEnabled(), and SetRadioIcon().

m_focus_color

StateColor RadioGroup::m_focus_color

private

Referenced by Create().

m_focused

bool RadioGroup::m_focused

private

Referenced by RadioGroup().

m_item_count

int RadioGroup::m_item_count

private

Referenced by Create(), Enable(), and SetSelection().

m_labelButtons

std::vector<Button*> RadioGroup::m_labelButtons

private

Referenced by Create(), Enable(), SetRadioTooltip(), and SetSelection().

m_labels

std::vector<wxString> RadioGroup::m_labels

private

Referenced by Create(), and SetSelection().

m_off

ScalableBitmap RadioGroup::m_off

private

Referenced by RadioGroup(), Create(), and SetRadioIcon().

m_off_hover

ScalableBitmap RadioGroup::m_off_hover

private

Referenced by RadioGroup(), and SetRadioIcon().

m_on

ScalableBitmap RadioGroup::m_on

private

Referenced by RadioGroup(), Create(), and SetRadioIcon().

m_on_hover

ScalableBitmap RadioGroup::m_on_hover

private

Referenced by RadioGroup(), and SetRadioIcon().

m_radioButtons

std::vector<wxStaticBitmap*> RadioGroup::m_radioButtons

private

Referenced by Create(), SelectNext(), SelectPrevious(), SetRadioIcon(), and SetRadioTooltip().

m_selectedIndex

int RadioGroup::m_selectedIndex

private

Referenced by RadioGroup(), Create(), GetSelection(), SelectNext(), SelectPrevious(), SetRadioIcon(), and SetSelection().

m_text_color

StateColor RadioGroup::m_text_color

private

Referenced by Create().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/RadioGroup.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Widgets/RadioGroup.cpp