KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
FILTER_COMBOPOPUP Class Reference

#include <filter_combobox.h>

Inheritance diagram for FILTER_COMBOPOPUP:
NET_SELECTOR_COMBOPOPUP SYMBOL_FILTER_COMBOPOPUP

Public Member Functions

 FILTER_COMBOPOPUP ()
 
bool Create (wxWindow *aParent) override
 
wxWindow * GetControl () override
 
void SetStringList (const wxArrayString &aStringList)
 
wxString GetStringValue () const override
 
void SetStringValue (const wxString &aNetName) override
 
void SetSelectedString (const wxString &aString)
 
void OnPopup () override
 
void OnStartingKey (wxKeyEvent &aEvent)
 
wxSize GetAdjustedSize (int aMinWidth, int aPrefHeight, int aMaxHeight) override
 
virtual void Accept ()
 

Protected Member Functions

std::optional< wxString > getSelectedValue () const
 Get the currently selected value in the list, or std::nullopt.
 
wxString getFilterValue () const
 Get the current value of the filter control.
 
virtual void getListContent (wxArrayString &aStringList)
 Fill the combobox list.
 
void rebuildList ()
 Call this to rebuild the list from the getListContent() method.
 

Protected Attributes

wxTextValidator * m_filterValidator
 
wxTextCtrl * m_filterCtrl
 
wxListBox * m_listBox
 
int m_minPopupWidth
 
int m_maxPopupHeight
 
wxEvtHandler * m_focusHandler
 
wxString m_selectedString
 
wxArrayString m_stringList
 

Private Member Functions

wxSize updateSize ()
 
void onIdle (wxIdleEvent &aEvent)
 
void onMouseMoved (const wxPoint aScreenPos)
 
void onMouseClick (wxMouseEvent &aEvent)
 
void onKeyDown (wxKeyEvent &aEvent)
 
void onEnter (wxCommandEvent &aEvent)
 
void onFilterEdit (wxCommandEvent &aEvent)
 
void doStartingKey (wxKeyEvent &aEvent)
 
void doSetFocus (wxWindow *aWindow)
 

Detailed Description

Definition at line 40 of file filter_combobox.h.

Constructor & Destructor Documentation

◆ FILTER_COMBOPOPUP()

FILTER_COMBOPOPUP::FILTER_COMBOPOPUP ( )

Definition at line 54 of file filter_combobox.cpp.

Member Function Documentation

◆ Accept()

void FILTER_COMBOPOPUP::Accept ( )
virtual

Reimplemented in NET_SELECTOR_COMBOPOPUP.

Definition at line 156 of file filter_combobox.cpp.

References getSelectedValue(), and m_selectedString.

Referenced by onEnter(), onKeyDown(), and onMouseClick().

◆ Create()

bool FILTER_COMBOPOPUP::Create ( wxWindow *  aParent)
override

Definition at line 65 of file filter_combobox.cpp.

References _, m_filterCtrl, m_filterValidator, m_listBox, onEnter(), onFilterEdit(), onIdle(), onKeyDown(), and onMouseClick().

◆ doSetFocus()

void FILTER_COMBOPOPUP::doSetFocus ( wxWindow *  aWindow)
private

Definition at line 432 of file filter_combobox.cpp.

References KIPLATFORM::UI::ForceFocus().

Referenced by onKeyDown(), onMouseMoved(), and OnStartingKey().

◆ doStartingKey()

void FILTER_COMBOPOPUP::doStartingKey ( wxKeyEvent &  aEvent)
private

Definition at line 398 of file filter_combobox.cpp.

References m_filterCtrl, and text.

Referenced by onKeyDown(), and OnStartingKey().

◆ GetAdjustedSize()

wxSize FILTER_COMBOPOPUP::GetAdjustedSize ( int  aMinWidth,
int  aPrefHeight,
int  aMaxHeight 
)
override

Definition at line 174 of file filter_combobox.cpp.

References m_maxPopupHeight, m_minPopupWidth, and updateSize().

◆ GetControl()

wxWindow * FILTER_COMBOPOPUP::GetControl ( )
inlineoverride

Definition at line 47 of file filter_combobox.h.

◆ getFilterValue()

wxString FILTER_COMBOPOPUP::getFilterValue ( ) const
protected

Get the current value of the filter control.

Can be empty.

Definition at line 218 of file filter_combobox.cpp.

References m_filterCtrl.

Referenced by SYMBOL_FILTER_COMBOPOPUP::getListContent(), NET_SELECTOR_COMBOPOPUP::getListContent(), and getListContent().

◆ getListContent()

void FILTER_COMBOPOPUP::getListContent ( wxArrayString &  aStringList)
protectedvirtual

Fill the combobox list.

Reimplemented in SYMBOL_FILTER_COMBOPOPUP, and NET_SELECTOR_COMBOPOPUP.

Definition at line 185 of file filter_combobox.cpp.

References getFilterValue(), and m_stringList.

Referenced by SYMBOL_FILTER_COMBOPOPUP::getListContent(), and rebuildList().

◆ getSelectedValue()

std::optional< wxString > FILTER_COMBOPOPUP::getSelectedValue ( ) const
protected

Get the currently selected value in the list, or std::nullopt.

Definition at line 207 of file filter_combobox.cpp.

References m_listBox.

Referenced by Accept(), and NET_SELECTOR_COMBOPOPUP::Accept().

◆ GetStringValue()

wxString FILTER_COMBOPOPUP::GetStringValue ( ) const
override

Definition at line 112 of file filter_combobox.cpp.

References m_selectedString.

Referenced by SYMBOL_FILTER_COMBOBOX::GetValue(), and OnPopup().

◆ onEnter()

void FILTER_COMBOPOPUP::onEnter ( wxCommandEvent &  aEvent)
private

Definition at line 382 of file filter_combobox.cpp.

References Accept().

Referenced by Create().

◆ onFilterEdit()

void FILTER_COMBOPOPUP::onFilterEdit ( wxCommandEvent &  aEvent)
private

Definition at line 388 of file filter_combobox.cpp.

References m_listBox, rebuildList(), and updateSize().

Referenced by Create().

◆ onIdle()

void FILTER_COMBOPOPUP::onIdle ( wxIdleEvent &  aEvent)
private

Definition at line 254 of file filter_combobox.cpp.

References KIPLATFORM::UI::GetMousePosition(), m_filterCtrl, m_focusHandler, and onMouseMoved().

Referenced by Create().

◆ onKeyDown()

void FILTER_COMBOPOPUP::onKeyDown ( wxKeyEvent &  aEvent)
private

Definition at line 322 of file filter_combobox.cpp.

References Accept(), doSetFocus(), doStartingKey(), m_filterCtrl, m_focusHandler, and m_listBox.

Referenced by Create().

◆ onMouseClick()

void FILTER_COMBOPOPUP::onMouseClick ( wxMouseEvent &  aEvent)
private

Definition at line 294 of file filter_combobox.cpp.

References Accept(), and m_listBox.

Referenced by Create().

◆ onMouseMoved()

void FILTER_COMBOPOPUP::onMouseMoved ( const wxPoint  aScreenPos)
private

Definition at line 275 of file filter_combobox.cpp.

References doSetFocus(), m_filterCtrl, and m_listBox.

Referenced by onIdle().

◆ OnPopup()

void FILTER_COMBOPOPUP::OnPopup ( )
override

Definition at line 134 of file filter_combobox.cpp.

References GetStringValue(), m_filterCtrl, m_listBox, and updateSize().

◆ OnStartingKey()

void FILTER_COMBOPOPUP::OnStartingKey ( wxKeyEvent &  aEvent)

Definition at line 149 of file filter_combobox.cpp.

References doSetFocus(), doStartingKey(), and m_filterCtrl.

Referenced by FILTER_COMBOBOX::onKeyDown().

◆ rebuildList()

void FILTER_COMBOPOPUP::rebuildList ( )
protected

Call this to rebuild the list from the getListContent() method.

Definition at line 198 of file filter_combobox.cpp.

References getListContent(), and m_listBox.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), onFilterEdit(), NET_SELECTOR_COMBOPOPUP::SetIndeterminateLabel(), NET_SELECTOR_COMBOPOPUP::SetNetInfo(), and SetStringList().

◆ SetSelectedString()

void FILTER_COMBOPOPUP::SetSelectedString ( const wxString &  aString)

Definition at line 127 of file filter_combobox.cpp.

References m_selectedString.

Referenced by FILTER_COMBOBOX::SetSelectedString().

◆ SetStringList()

void FILTER_COMBOPOPUP::SetStringList ( const wxArrayString &  aStringList)

Definition at line 104 of file filter_combobox.cpp.

References m_stringList, and rebuildList().

Referenced by FILTER_COMBOBOX::SetStringList().

◆ SetStringValue()

void FILTER_COMBOPOPUP::SetStringValue ( const wxString &  aNetName)
override

Definition at line 118 of file filter_combobox.cpp.

◆ updateSize()

wxSize FILTER_COMBOPOPUP::updateSize ( )
private

Definition at line 224 of file filter_combobox.cpp.

References KIUI::GetTextSize(), LIST_ITEM_PADDING, LIST_PADDING, m_listBox, m_maxPopupHeight, and m_minPopupWidth.

Referenced by GetAdjustedSize(), onFilterEdit(), and OnPopup().

Member Data Documentation

◆ m_filterCtrl

wxTextCtrl* FILTER_COMBOPOPUP::m_filterCtrl
protected

Definition at line 101 of file filter_combobox.h.

Referenced by Create(), doStartingKey(), getFilterValue(), onIdle(), onKeyDown(), onMouseMoved(), OnPopup(), and OnStartingKey().

◆ m_filterValidator

wxTextValidator* FILTER_COMBOPOPUP::m_filterValidator
protected

Definition at line 100 of file filter_combobox.h.

Referenced by Create().

◆ m_focusHandler

wxEvtHandler* FILTER_COMBOPOPUP::m_focusHandler
protected

Definition at line 106 of file filter_combobox.h.

Referenced by onIdle(), and onKeyDown().

◆ m_listBox

wxListBox* FILTER_COMBOPOPUP::m_listBox
protected

Definition at line 102 of file filter_combobox.h.

Referenced by Create(), getSelectedValue(), onFilterEdit(), onKeyDown(), onMouseClick(), onMouseMoved(), OnPopup(), rebuildList(), and updateSize().

◆ m_maxPopupHeight

int FILTER_COMBOPOPUP::m_maxPopupHeight
protected

Definition at line 104 of file filter_combobox.h.

Referenced by GetAdjustedSize(), and updateSize().

◆ m_minPopupWidth

int FILTER_COMBOPOPUP::m_minPopupWidth
protected

Definition at line 103 of file filter_combobox.h.

Referenced by GetAdjustedSize(), and updateSize().

◆ m_selectedString

wxString FILTER_COMBOPOPUP::m_selectedString
protected

Definition at line 108 of file filter_combobox.h.

Referenced by Accept(), GetStringValue(), and SetSelectedString().

◆ m_stringList

wxArrayString FILTER_COMBOPOPUP::m_stringList
protected

Definition at line 109 of file filter_combobox.h.

Referenced by getListContent(), and SetStringList().

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