MousePrefs Class Reference

A PrefsPanel that presents an interface for user to view the default bindings of mouse buttons to commands. More...

#include <MousePrefs.h>

Inheritance diagram for MousePrefs:

Collaboration diagram for MousePrefs:

Public Member Functions
	MousePrefs (wxWindow *parent, wxWindowID winid)
	Constructor. More...
	~MousePrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
	Places controls on the panel and also exchanges data with them. More...
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
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

Private Member Functions
void	Populate ()
	Creates the dialog and its contents. More...
void	CreateList ()
	Creates the contents of mList. More...
void	AddItem (TranslatableString const &buttons, TranslatableString const &tool, TranslatableString const &action, TranslatableString const &comment={})
	Adds an item to mList. More...
void	OnShow (wxShowEvent &event)

Private Attributes
wxListCtrl *	mList

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel that presents an interface for user to view the default bindings of mouse buttons to commands.

April/2003: These are default bindings and are not yet configurable. They are provided to give information about what the bindings are.

Configuration when available will be mostly used by power users who are unlikely to change the default bindings, but will add bindings (e.g. for cut, play, and their own nyquist filters) using currently unused combinations.

Unlike key-bindings which are parameterless, mouse bindings provide parameters:

• a single point for a click, and
• a stream of points or a start and end point for a drag.

If we allow a nyquist filter to be bound to the mouse, instead of being applied to the current selection it would be applied to the start and end points of the drag.

Definition at line 22 of file MousePrefs.h.

Constructor & Destructor Documentation

MousePrefs()

MousePrefs::MousePrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Constructor.

Definition at line 60 of file MousePrefs.cpp.

:  PrefsPanel(parent, winid, XO("Mouse"))
{
   Populate();
 
   // See bug #2315 for discussion. This should be reviewed
   // and (possibly) removed after wx3.1.3.
   Bind(wxEVT_SHOW, &MousePrefs::OnShow, this);
}

References OnShow(), and Populate().

Here is the call graph for this function:

~MousePrefs()

MousePrefs::~MousePrefs

(

)

Definition at line 70 of file MousePrefs.cpp.

{
}

Member Function Documentation

AddItem()

void MousePrefs::AddItem ( TranslatableString const &  buttons, TranslatableString const &  tool, TranslatableString const &  action, TranslatableString const &  comment = {}  )

private

Adds an item to mList.

Definition at line 203 of file MousePrefs.cpp.

{
   int i = mList->GetItemCount();
   mList->InsertItem(i, tool.Translation());
   mList->SetItem(i, ActionColumn, action.Translation());
   mList->SetItem(i, ButtonsColumn, buttons.Translation());
 
   // Add a space before the text to work around a minor bug in the
   // list control when showing narrow columns.
   mList->SetItem(i, CommentColumn, wxT(" ") + comment.Translation());
}

References ActionColumn, ButtonsColumn, CommentColumn, mList, TranslatableString::Translation(), and wxT().

Referenced by CreateList().

Here is the call graph for this function:

Here is the caller graph for this function:

Commit()

bool MousePrefs::Commit ( )

overridevirtual

Update the preferences stored on disk. Currently does nothing as Mouse Preferences don't change.

Implements PrefsPanel.

Definition at line 231 of file MousePrefs.cpp.

{
// Not yet required...
//   ShuttleGui S(this, eIsSavingToPrefs);
//   PopulateOrExchange(S);
   return true;
}

CreateList()

void MousePrefs::CreateList ( )

private

Creates the contents of mList.

Definition at line 121 of file MousePrefs.cpp.

{
   //A dummy first column, which is then deleted, is a workaround - under Windows the first column
   //can't be right aligned.
   mList->InsertColumn(0,             wxT(""),              wxLIST_FORMAT_LEFT);
   mList->InsertColumn(ToolColumn + 1,    _("Tool"),            wxLIST_FORMAT_RIGHT);
   mList->InsertColumn(ActionColumn + 1,  _("Command Action"),  wxLIST_FORMAT_RIGHT);
   mList->InsertColumn(ButtonsColumn + 1, _("Buttons"),         wxLIST_FORMAT_LEFT);
   mList->InsertColumn(CommentColumn + 1, _("Comments"),        wxLIST_FORMAT_LEFT);
   mList->DeleteColumn(0);
 
   AddItem(XO("Left-Click"),        XO("Select"),   XO("Set Selection Point"));
   AddItem(XO("Left-Drag"),         XO("Select"),   XO("Set Selection Range"));
   AddItem(XO("Shift-Left-Click"),  XO("Select"),   XO("Extend Selection Range"));
   AddItem(XO("Left-Double-Click"), XO("Select"),   XO("Select Clip or Entire Track"));
#ifdef EXPERIMENTAL_SCRUBBING_SCROLL_WHEEL
   AddItem(XO("Wheel-Rotate"),      XO("Select"),   XO("Change scrub speed"));
#endif
 
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   // JKC: Prompt is disabled for now.  It's a toggle rather than a drag modifier.
   // more like Snap-to than anything else.
   // Spectral selection
   // AddItem(XO("ESC"),              XO("Select"),    XO("Toggle center snapping in spectrogram"));
#endif
 
   AddItem(XO("Left-Click"),       XO("Zoom"),      XO("Zoom in on Point"));
   AddItem(XO("Left-Drag"),        XO("Zoom"),      XO("Zoom in on a Range"), XO("same as right-drag"));
   AddItem(XO("Right-Click"),      XO("Zoom"),      XO("Zoom out one step"));
   AddItem(XO("Right-Drag"),       XO("Zoom"),      XO("Zoom in on a Range"), XO("same as left-drag"));
   AddItem(XO("Shift-Drag"),       XO("Zoom"),      XO("Zoom out on a Range"));
   AddItem(XO("Middle-Click"),     XO("Zoom"),      XO("Zoom default"));
 
 
   AddItem(XO("Left-Drag"),
   /* i18n-hint: The envelope is a curve that controls the audio loudness.*/
      XO("Envelope"),
   /* i18n-hint: The envelope is a curve that controls the audio loudness.*/
      XO("Change Amplification Envelope"));
 
   AddItem(XO("Left-Click"),       XO("Pencil"),    XO("Change Sample"));
   AddItem(XO("Alt-Left-Click"),   XO("Pencil"),    XO("Smooth at Sample"));
   AddItem(XO("Left-Drag"),        XO("Pencil"),    XO("Change Several Samples"));
   AddItem(CTRL + XO("-Left-Drag"),XO("Pencil"),    XO("Change ONE Sample only"));
 
   AddItem(XO("Left-Click"),       XO("Multi"),     XO("Set Selection Point"), XO("same as select tool"));
   AddItem(XO("Left-Drag"),        XO("Multi"),     XO("Set Selection Range"), XO("same as select tool"));
   AddItem(XO("Right-Click"),      XO("Multi"),     XO("Zoom out one step"),   XO("same as zoom tool"));
   AddItem(XO("Right-Drag"),       XO("Multi"),     XO("Zoom in on a Range"),  XO("same as zoom tool"));
 
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   // JKC: Prompt is disabled for now.  It's a toggle rather than a drag modifier.
   // more like Snap-to than anything else.
   // Spectral selection
   // AddItem(XO("ESC"),              XO("Select"),    XO("Toggle center snapping in spectrogram"), XO("same as select tool"));
#endif
 
   AddItem(XO("Wheel-Rotate"),                XO("Any"),   XO("Scroll tracks up or down"));
   AddItem(XO("Shift-Wheel-Rotate"),          XO("Any"),   XO("Scroll waveform"));
   AddItem(CTRL + XO("-Wheel-Rotate"),        XO("Any"),   XO("Zoom waveform in or out"));
   AddItem(CTRL + XO("-Shift-Wheel-Rotate"),  XO("Any"),   XO("Vertical Scale Waveform (dB) range"));
   
   AddItem(XO("Shift-Left-Drag"),  XO("Any"),XO("Move all clips in track left/right"), XO("using clip handles"));
   AddItem(CTRL + XO("-Left-Drag"),XO("Any"),XO("Move clip up/down between tracks"), XO("using clip handles"));
   AddItem(XO("Left-Drag"),        XO("Any"),XO("Move clip left/right or between tracks"), XO("using clip handles"));
 
   mList->SetColumnWidth(ToolColumn, wxLIST_AUTOSIZE);
   mList->SetColumnWidth(ActionColumn, wxLIST_AUTOSIZE);
   mList->SetColumnWidth(ButtonsColumn, wxLIST_AUTOSIZE);
   mList->SetColumnWidth(CommentColumn, wxLIST_AUTOSIZE);
 
// PRL commented out, didn't look good to me on Mac at least
/*
   // Not sure if this extra column is a good idea or not.
   // Anyway, 5 pixels wide is wide enough that some people who are curious will drag it
   // wider to see what's there (the comments show that the duplication of functions
   // is for a reason, and not just random).
   mList->SetColumnWidth(CommentColumn, 5);
   */
}

References _, ActionColumn, AddItem(), ButtonsColumn, CommentColumn, CTRL, mList, ToolColumn, wxT(), and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString MousePrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 79 of file MousePrefs.cpp.

{
   return XO("Preferences for Mouse");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol MousePrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 74 of file MousePrefs.cpp.

{
   return MOUSE_PREFS_PLUGIN_SYMBOL;
}

References MOUSE_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID MousePrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 84 of file MousePrefs.cpp.

{
   return "Mouse_Preferences";
}

OnShow()

void MousePrefs::OnShow ( wxShowEvent &  event )

private

Definition at line 219 of file MousePrefs.cpp.

{
   event.Skip();
 
   if (event.IsShown())
   {
      mList->Refresh();
   }
}

References mList.

Referenced by MousePrefs().

Here is the caller graph for this function:

Populate()

void MousePrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 90 of file MousePrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
   CreateList();
   if (mList->GetItemCount() > 0) {
      // set first item to be selected (and the focus when the
      // list first becomes the focus)
      mList->SetItemState(0, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED,
         wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
   }
}

References CreateList(), eIsCreatingFromPrefs, mList, PopulateOrExchange(), and S.

Referenced by MousePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void MousePrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Places controls on the panel and also exchanges data with them.

Definition at line 109 of file MousePrefs.cpp.

{
   S.SetBorder(2);
 
   S.StartStatic(XO("Mouse Bindings (default values, not configurable)"), 1);
   {
      mList = S.AddListControlReportMode();
   }
   S.EndStatic();
}

References mList, S, and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mList

wxListCtrl* MousePrefs::mList

private

Definition at line 46 of file MousePrefs.h.

Referenced by AddItem(), CreateList(), OnShow(), Populate(), and PopulateOrExchange().

---

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

• MousePrefs.h
• MousePrefs.cpp