/**********************************************************************

  Audacity: A Digital Audio Editor

  MousePrefs.cpp

  Presents 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.

**********************************************************************/

#include <wx/defs.h>
#include <wx/button.h>
#include <wx/checkbox.h>
#include <wx/choice.h>
#include <wx/gdicmn.h>
#include <wx/intl.h>
#include <wx/msgdlg.h>
#include <wx/sizer.h>
#include <wx/statbox.h>
#include <wx/stattext.h>
#include <wx/textctrl.h>
#include <wx/listctrl.h>
#include <wx/utils.h>
#include <wx/window.h>

#include "../Prefs.h"
#include "MousePrefs.h"


// The numbers of the columns of the mList.
enum { BlankColumn=0, ToolColumn=1, ActionColumn=2, ButtonsColumn=3};


BEGIN_EVENT_TABLE(MousePrefs, wxPanel)
END_EVENT_TABLE()	



MousePrefs::MousePrefs(wxWindow * parent):
PrefsPanel(parent)
{
   /* read prefs all at once, then set up the dialog */
   // There aren't any configurable preferences yet.
   gPrefs->SetPath("/Mouse");
//   mValue = gPrefs->Read("itemname", "");
   gPrefs->SetPath("/");

//   topSizer = new wxBoxSizer( wxVERTICAL );
   outSizer = new wxBoxSizer( wxVERTICAL );

   wxStaticBoxSizer *bindingsSizer =
      new wxStaticBoxSizer(
         new wxStaticBox(this, -1, _("Mouse Bindings (default values, not configurable)")),
            wxVERTICAL);

   mList = new wxListCtrl( this, -1 ,
      wxDefaultPosition, wxDefaultSize,
      wxLC_REPORT | wxLC_HRULES | wxLC_VRULES | wxSUNKEN_BORDER 
      );

   wxASSERT( mList );

   //An empty first column is a workaround - under Win98 the first column 
   //can't be right aligned.
   mList->InsertColumn(BlankColumn,   "",               wxLIST_FORMAT_LEFT );
   mList->InsertColumn(ToolColumn,    _("Tool"),            wxLIST_FORMAT_RIGHT );
   mList->InsertColumn(ActionColumn,  _("Command Action"),  wxLIST_FORMAT_RIGHT );
   mList->InsertColumn(ButtonsColumn, _("Buttons"),         wxLIST_FORMAT_LEFT );

   AddItem( _("Left-Click"),       _("Select"),    _("Set Selection Point") );
   AddItem( _("Left-Drag"),        _("Select"),    _("Set Selection Range") );
   AddItem( _("Shift-Left-Click"), _("Select"),    _("Extend Selection Range") );

   AddItem( _("Left-Click"),       _("Zoom"),      _("Zoom in on Point") );
   AddItem( _("Left-Drag"),        _("Zoom"),      _("Zoom in on a Range") );
   AddItem( _("Right-Click"),      _("Zoom"),      _("Zoom out one step") );
   AddItem( _("Right-Drag"),       _("Zoom"),      _("Same as Left-Drag") );

   AddItem( _("Left-Drag"),        _("Time-Shift"),_("Time shift sequence") );
   AddItem( _("Left-Drag"),        _("Envelope"),  _("Change Amplification Envelope") );

   AddItem( _("Left-Click"),       _("Pencil"),    _("Change Sample") );
   AddItem( _("Alt-Left-Click"),   _("Pencil"),    _("Smooth at Sample") );
   AddItem( _("Left-Drag"),        _("Pencil"),    _("Change Several Samples") );
   AddItem( _("Ctrl-Left-Drag"),   _("Pencil"),    _("Change ONE Sample only") );

   AddItem( _("Left Click"),       _("Multi"),     _("Same as select tool") );
   AddItem( _("Left Drag"),        _("Multi"),     _("Same as select tool") );
   AddItem( _("Right Click"),      _("Multi"),     _("Same as zoom tool") );
   AddItem( _("Right Drag"),       _("Multi"),     _("Same as zoom tool") );

   AddItem( _("Wheel-Rotate"),     _("Any"),       _("Scroll up or down") );
   AddItem( _("Ctrl-Wheel-Rotate"),_("Any"),       _("Zoom in or out") );

   mList->SetColumnWidth( BlankColumn,  0 ); // First column width is zero, to hide it.
   mList->SetColumnWidth( ToolColumn,   wxLIST_AUTOSIZE );
   mList->SetColumnWidth( ActionColumn, wxLIST_AUTOSIZE );
   mList->SetColumnWidth( ButtonsColumn, wxLIST_AUTOSIZE );

   bindingsSizer->Add( mList, 1, wxEXPAND );
//   topSizer->Add( bindingsSizer, 1, wxEXPAND );
//   outSizer->Add(topSizer, 1, wxGROW|wxALL, TOP_LEVEL_BORDER);
   outSizer->Add(bindingsSizer, 1, wxGROW|wxALL, TOP_LEVEL_BORDER);

   SetAutoLayout(true);
   outSizer->Fit(this);
   outSizer->SetSizeHints(this);
   SetSizer(outSizer);
}

MousePrefs::~MousePrefs()
{
}

void MousePrefs::AddItem( wxString const & MouseButtons, wxString const & Tool, wxString const & Action )
{
   int i=mList->GetItemCount();
   mList->InsertItem( i, "" );
   mList->SetItem( i, ToolColumn, Tool );
   mList->SetItem( i, ActionColumn, Action );
   mList->SetItem( i, ButtonsColumn, MouseButtons );
}


/// Update the preferences stored on disk.
/// Currently does nothing as Mouse Preferences don't change.
bool MousePrefs::Apply()
{
   /* Step 2: Write to gPrefs */
   gPrefs->SetPath("/Mouse");
//   gPrefs->Write("itemname", mValue);
   gPrefs->SetPath("/");
   return true;
}