RulerPanel Class Reference

RulerPanel class allows you to work with a Ruler like any other wxWindow. More...

#include <RulerPanel.h>

Inheritance diagram for RulerPanel:

Collaboration diagram for RulerPanel:

Classes
struct	Options

Public Types
using	Range = std::pair< double, double >

Public Member Functions
	RulerPanel (wxWindow *parent, wxWindowID id, wxOrientation orientation, const wxSize &bounds, const Range &range, const RulerFormat &format, const TranslatableString &units, const Options &options={}, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
	~RulerPanel ()
void	DoSetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO) override
void	OnErase (wxEraseEvent &evt)
void	OnPaint (wxPaintEvent &evt)
void	OnSize (wxSizeEvent &evt)
void	SetTickColour (wxColour &c)
bool	AcceptsFocus () const override
bool	AcceptsFocusFromKeyboard () const override
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Public Attributes
Ruler	ruler

Detailed Description

RulerPanel class allows you to work with a Ruler like any other wxWindow.

Definition at line 19 of file RulerPanel.h.

Member Typedef Documentation

Range

using RulerPanel::Range = std::pair<double, double>

Definition at line 23 of file RulerPanel.h.

Constructor & Destructor Documentation

RulerPanel()

RulerPanel::RulerPanel	(	wxWindow *	parent,
		wxWindowID	id,
		wxOrientation	orientation,
		const wxSize &	bounds,
		const Range &	range,
		const RulerFormat &	format,
		const TranslatableString &	units,
		const Options &	options = {},
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize
	)

Definition at line 35 of file RulerPanel.cpp.

   : wxPanelWrapper(parent, id, pos, size)
   , ruler{
      [&]() -> const RulerUpdater& {
         if (options.log)
            return LogarithmicUpdater::Instance();
         else
            return LinearUpdater::Instance();
      }(),
      format
   }
{
   ruler.SetBounds( 0, 0, bounds.x, bounds.y );
   ruler.SetOrientation(orientation);
   ruler.SetRange( range.first, range.second );
   ruler.SetUnits(units);
   ruler.SetFlip(options.flip);
   ruler.SetLabelEdges(options.labelEdges);
   ruler.mbTicksAtExtremes = options.ticksAtExtremes;
   if (orientation == wxVERTICAL) {
      wxCoord w;
      ruler.GetMaxSize(&w, NULL);
      SetMinSize(wxSize(w, 150));  // height needed for wxGTK
   }
   else if (orientation == wxHORIZONTAL) {
      wxCoord h;
      ruler.GetMaxSize(NULL, &h);
      SetMinSize(wxSize(wxDefaultCoord, h));
   }
   if (options.hasTickColour)
      ruler.SetTickColour( options.tickColour );
}

References anonymous_namespace{ExportPCM.cpp}::format, LinearUpdater::Instance(), and LogarithmicUpdater::Instance().

Here is the call graph for this function:

~RulerPanel()

RulerPanel::~RulerPanel

(

)

Definition at line 77 of file RulerPanel.cpp.

{
}

Member Function Documentation

AcceptsFocus()

bool RulerPanel::AcceptsFocus ( ) const

inlineoverride

Definition at line 73 of file RulerPanel.h.

{ return false; }

AcceptsFocusFromKeyboard()

bool RulerPanel::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 75 of file RulerPanel.h.

{ return false; }

DoSetSize()

void RulerPanel::DoSetSize ( int  x, int  y, int  width, int  height, int  sizeFlags = wxSIZE_AUTO  )

override

Definition at line 106 of file RulerPanel.cpp.

{
   wxPanelWrapper::DoSetSize(x, y, width, height, sizeFlags);
 
   int w, h;
   GetClientSize(&w, &h);
 
   ruler.SetBounds(0, 0, w-1, h-1);
}

References ruler, and Ruler::SetBounds().

Here is the call graph for this function:

OnErase()

void RulerPanel::OnErase

(

wxEraseEvent &

evt

)

Definition at line 81 of file RulerPanel.cpp.

{
   // Ignore it to prevent flashing
}

OnPaint()

void RulerPanel::OnPaint

(

wxPaintEvent &

evt

)

Definition at line 86 of file RulerPanel.cpp.

{
   wxPaintDC dc(this);
 
#if defined(__WXMSW__)
   dc.Clear();
#endif
 
   ruler.Draw(dc);
}

References Ruler::Draw(), and ruler.

Here is the call graph for this function:

OnSize()

void RulerPanel::OnSize

(

wxSizeEvent &

evt

)

Definition at line 97 of file RulerPanel.cpp.

{
   Refresh();
}

SetTickColour()

void RulerPanel::SetTickColour ( wxColour &  c )

inline

Definition at line 70 of file RulerPanel.h.

{ ruler.SetTickColour( c );}

References anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), and Ruler::SetTickColour().

Here is the call graph for this function:

Member Data Documentation

ruler

Ruler RulerPanel::ruler

Definition at line 79 of file RulerPanel.h.

Referenced by DoSetSize(), FrequencyPlotDialog::DrawPlot(), EqualizationUI::OnLinFreq(), EqualizationPanel::OnPaint(), EffectScienFilterPanel::OnPaint(), OnPaint(), EffectScienFilter::TransferGraphLimitsFromWindow(), EqualizationUI::UpdateDraw(), EqualizationUI::UpdateGraphic(), and EqualizationUI::UpdateRuler().

---

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

• RulerPanel.h
• RulerPanel.cpp