RESETTABLE_PANEL Class Reference

A wxPanel that is designed to be reset in a standard manner. More...

#include <resettable_panel.h>

Inheritance diagram for RESETTABLE_PANEL:

Public Member Functions
	RESETTABLE_PANEL (wxWindow *aParent, wxWindowID aId=wxID_ANY, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxSize(-1,-1), long aStyle=wxTAB_TRAVERSAL, const wxString &aName=wxEmptyString)
virtual void	ResetPanel ()=0
	Reset the contents of this panel. More...
virtual wxString	GetResetTooltip () const
	Get the tooltip the reset button should display when showing this panel. More...
wxString	GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override
	Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }. More...

Detailed Description

A wxPanel that is designed to be reset in a standard manner.

Definition at line 34 of file resettable_panel.h.

Constructor & Destructor Documentation

RESETTABLE_PANEL()

RESETTABLE_PANEL::RESETTABLE_PANEL ( wxWindow *  aParent, wxWindowID  aId = wxID_ANY, const wxPoint &  aPos = wxDefaultPosition, const wxSize &  aSize = wxSize( -1,-1 ), long  aStyle = wxTAB_TRAVERSAL, const wxString &  aName = wxEmptyString  )

inline

Definition at line 37 of file resettable_panel.h.

 : wxPanel( aParent, aId, aPos, aSize, aStyle | wxRESETTABLE, aName )
 {
 Bind( wxEVT_COMMAND_BUTTON_CLICKED,
 [&]( wxCommandEvent& aCmd )
 {
 if( aCmd.GetId() == ID_RESET_PANEL )
 ResetPanel();
 else
 aCmd.Skip();
 } );
 }

References ID_RESET_PANEL, and ResetPanel().

Member Function Documentation

GetHelpTextAtPoint()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint ( const wxPoint &  aPt, wxHelpEvent::Origin  aOrigin  ) const

inlineoverride

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

 {
 if( aPt == wxPoint( -INT_MAX, INT_MAX ) )
 return GetResetTooltip();
 else
 return wxPanel::GetHelpTextAtPoint( aPt, aOrigin );
 }

References GetResetTooltip().

GetResetTooltip()

virtual wxString RESETTABLE_PANEL::GetResetTooltip ( ) const

inlinevirtual

Get the tooltip the reset button should display when showing this panel.

Returns

the tooltip

Reimplemented in PANEL_COLOR_SETTINGS, and PANEL_HOTKEYS_EDITOR.

Definition at line 64 of file resettable_panel.h.

 {
 return _( "Reset all settings on this page to their default" );
 }

References _.

Referenced by GetHelpTextAtPoint().

ResetPanel()

virtual void RESETTABLE_PANEL::ResetPanel ( )

pure virtual

Reset the contents of this panel.

Implemented in PANEL_3D_COLORS, PANEL_3D_DISPLAY_OPTIONS, PANEL_3D_OPENGL_OPTIONS, PANEL_3D_RAYTRACING_OPTIONS, PANEL_EESCHEMA_ANNOTATION_OPTIONS, PANEL_EESCHEMA_COLOR_SETTINGS, PANEL_EESCHEMA_DISPLAY_OPTIONS, PANEL_EESCHEMA_EDITING_OPTIONS, PANEL_SETUP_PINMAP, PANEL_SYM_DISPLAY_OPTIONS, PANEL_SYM_EDITING_OPTIONS, PANEL_GERBVIEW_DISPLAY_OPTIONS, PANEL_GERBVIEW_EXCELLON_SETTINGS, PANEL_COLOR_SETTINGS, PANEL_COMMON_SETTINGS, PANEL_DATA_COLLECTION, PANEL_MOUSE_SETTINGS, PANEL_HOTKEYS_EDITOR, PANEL_PL_EDITOR_COLOR_SETTINGS, PANEL_PL_EDITOR_DISPLAY_OPTIONS, PANEL_DISPLAY_OPTIONS, PANEL_EDIT_OPTIONS, PANEL_FP_EDITOR_DEFAULTS, PANEL_PCBNEW_COLOR_SETTINGS, and PANEL_PCBNEW_DISPLAY_ORIGIN.

Referenced by RESETTABLE_PANEL().

---

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

• resettable_panel.h