PackageListSearchCtrl Class Reference

This class specializes the generic search control to interact with the package list of the package repository browser. More...

Inheritance diagram for PackageListSearchCtrl:

Collaboration diagram for PackageListSearchCtrl:

Public Member Functions
	PackageListSearchCtrl (wxWindow *parent, wxWindowID id, const wxString &hint=wxEmptyString, const wxString &calltip=wxEmptyString, wxcode::wxTreeListCtrl *associatedCtrl=nullptr)
Public Member Functions inherited from SearchCtrl
	SearchCtrl (wxWindow *parent, wxWindowID id, const wxString &value=wxEmptyString, int style=wxCB_SORT)
void	OnItemSelect (wxCommandEvent &event)
	This event handler function will be fired, if the user selects a proposed string in the opened dropdown list. More...
void	OnTextChange (wxCommandEvent &event)
	This event handler function will be fired, if the user changes the text in the control. It will provide a dropdown menu with possible candidates matching to the provided search string. More...
void	OnMouseEnter (wxMouseEvent &event)
	This event handler will show the drop down list, if the text field contains data and the mouse enters the text field. Replacement for the buggy EVT_SET_FOCUS event. More...
	DECLARE_EVENT_TABLE ()

Protected Member Functions
virtual bool	selectItem (const wxString &value) override
	This method searches and selects the item with the passed label in the associated tree. More...
wxTreeItemId	findItem (const wxString &value, wxTreeItemId node)
	This method searches for the tree item, whose label corresponds to the passed string. More...
virtual wxArrayString	getCandidates (const wxString &enteredText) override
	This method returns an array of strings containing possible candidates for the passed search string. More...
wxArrayString	getChildCandidates (const wxString &enteredText, wxTreeItemId node)
	This method returns an array of strings containing possible candiates for the passed search string, which correspond to the current tree node, its siblings and its childs. More...
Protected Member Functions inherited from SearchCtrl
virtual bool	selectItem (const wxString &value)
	Child classes may override this member function to do something, when the user selects an item in the popup. More...
virtual wxString	getDragDropText (const wxString &value)
	Child classes may override this member function to provide a custom string for the built-in drag-drop functionality. More...
virtual wxArrayString	getCandidates (const wxString &enteredText)
	Child classes must override this member function to provide the candidates to be filled into the popup based upon the letters entered in the text entry window. More...

Private Attributes
wxcode::wxTreeListCtrl *	m_associatedCtrl

Additional Inherited Members
Protected Attributes inherited from SearchCtrl
SearchCtrlPopup *	popUp

Detailed Description

This class specializes the generic search control to interact with the package list of the package repository browser.

Definition at line 45 of file pluginrepodialog.cpp.

Constructor & Destructor Documentation

PackageListSearchCtrl()

PackageListSearchCtrl::PackageListSearchCtrl ( wxWindow *  parent, wxWindowID  id, const wxString &  hint = wxEmptyString, const wxString &  calltip = wxEmptyString, wxcode::wxTreeListCtrl *  associatedCtrl = nullptr  )

inline

Definition at line 58 of file pluginrepodialog.cpp.

References CTRLWIDTH, SearchCtrl::popUp, SearchCtrlPopup::SetCallTips(), and SearchCtrlPopup::SetColSizes().

Here is the call graph for this function:

Member Function Documentation

findItem()

wxTreeItemId PackageListSearchCtrl::findItem ( const wxString &  value, wxTreeItemId  node  )

protected

This method searches for the tree item, whose label corresponds to the passed string.

Parameters

value	const wxString&
node	wxTreeItemId

Returns

wxTreeItemId

Definition at line 126 of file pluginrepodialog.cpp.

References findItem(), and m_associatedCtrl.

Referenced by findItem(), and selectItem().

Here is the call graph for this function:

getCandidates()

wxArrayString PackageListSearchCtrl::getCandidates ( const wxString &  enteredText )

overrideprotectedvirtual

This method returns an array of strings containing possible candidates for the passed search string.

Parameters

enteredText

const wxString&

Returns

wxArrayString

Reimplemented from SearchCtrl.

Definition at line 169 of file pluginrepodialog.cpp.

References getChildCandidates(), and m_associatedCtrl.

Here is the call graph for this function:

getChildCandidates()

wxArrayString PackageListSearchCtrl::getChildCandidates ( const wxString &  enteredText, wxTreeItemId  node  )

protected

This method returns an array of strings containing possible candiates for the passed search string, which correspond to the current tree node, its siblings and its childs.

Parameters

enteredText	const wxString&
node	wxTreeItemId

Returns

wxArrayString

Definition at line 203 of file pluginrepodialog.cpp.

References getChildCandidates(), m_associatedCtrl, and mu::rint().

Referenced by getCandidates(), and getChildCandidates().

Here is the call graph for this function:

selectItem()

bool PackageListSearchCtrl::selectItem ( const wxString &  value )

overrideprotectedvirtual

This method searches and selects the item with the passed label in the associated tree.

Parameters

value

const wxString&

Returns

bool

Reimplemented from SearchCtrl.

Definition at line 84 of file pluginrepodialog.cpp.

References findItem(), and m_associatedCtrl.

Here is the call graph for this function:

Member Data Documentation

m_associatedCtrl

wxcode::wxTreeListCtrl* PackageListSearchCtrl::m_associatedCtrl

private

Definition at line 48 of file pluginrepodialog.cpp.

Referenced by findItem(), getCandidates(), getChildCandidates(), and selectItem().

---

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

• D:/CPP/numere-source/trunk/gui/dialogs/pluginrepodialog.cpp