ExtImportPrefs Class Reference

A PrefsPanel used to select extended import filter options. More...

#include <ExtImportPrefs.h>

Inheritance diagram for ExtImportPrefs:

Collaboration diagram for ExtImportPrefs:

Public Member Functions
	ExtImportPrefs (wxWindow *parent, wxWindowID winid)
	~ExtImportPrefs ()
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
void	OnShow (wxShowEvent &event)
void	OnPluginKeyDown (wxListEvent &event)
void	OnPluginBeginDrag (wxListEvent &event)
void	OnRuleTableKeyDown (wxKeyEvent &event)
void	OnRuleTableSelect (wxGridEvent &event)
void	OnRuleTableEdit (wxGridEvent &event)
void	OnRuleTableSelectRange (wxGridRangeSelectEvent &event)
void	OnRuleTableCellClick (wxGridEvent &event)
void	OnAddRule (wxCommandEvent &event)
void	OnDelRule (wxCommandEvent &event)
void	OnRuleMoveUp (wxCommandEvent &event)
void	OnRuleMoveDown (wxCommandEvent &event)
void	OnFilterMoveUp (wxCommandEvent &event)
void	OnFilterMoveDown (wxCommandEvent &event)
void	OnNavKey (wxNavigationKeyEvent &event)
void	SwapRows (int row1, int row2)
void	SwapPluginRows (int row1, int row2)
Grid *	GetRuleTable ()
wxListCtrl *	GetPluginList ()
wxWindow *	GetDragFocus ()
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	FakeOnPluginKeyDown (int keycode)
void	DoOnRuleTableKeyDown (int keycode)
bool	DoOnPluginKeyDown (int code)
void	DoOnRuleTableSelect (int toprow)
void	AddItemToTable (int index, const ExtImportItem *item)
void	Populate ()
	Creates the dialog and its contents. More...

Private Attributes
Grid *	RuleTable
wxListCtrl *	PluginList
wxButton *	AddRule
wxButton *	DelRule
wxButton *	MoveRuleUp
wxButton *	MoveRuleDown
wxButton *	MoveFilterUp
wxButton *	MoveFilterDown
wxTextDataObject *	dragtext1 {}
wxTextDataObject *	dragtext2 {}
bool	mCreateTable
wxWindow *	mDragFocus
bool	mFakeKeyEvent
bool	mStopRecursiveSelection
int	last_selected

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 used to select extended import filter options.

Definition at line 49 of file ExtImportPrefs.h.

Constructor & Destructor Documentation

ExtImportPrefs()

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

Definition at line 60 of file ExtImportPrefs.cpp.

:   PrefsPanel(parent, winid, XO("Extended Import")), RuleTable(NULL),
    PluginList(NULL), mCreateTable (false), mDragFocus (NULL),
    mFakeKeyEvent (false), mStopRecursiveSelection (false), last_selected (-1)
{
   Populate();
 
   // See bug #2315 for discussion
   // This should be reviewed and (possibly) removed after wx3.1.3.
   Bind(wxEVT_SHOW, &ExtImportPrefs::OnShow, this);
}

References OnShow().

Here is the call graph for this function:

~ExtImportPrefs()

ExtImportPrefs::~ExtImportPrefs

(

)

Definition at line 73 of file ExtImportPrefs.cpp.

{
}

Member Function Documentation

AddItemToTable()

void ExtImportPrefs::AddItemToTable ( int  index, const ExtImportItem *  item  )

private

Definition at line 592 of file ExtImportPrefs.cpp.

{
   wxString extensions, mime_types;
   if (item->extensions.size() > 0)
   {
      extensions.Append (item->extensions[0]);
      for (unsigned int i = 1; i < item->extensions.size(); i++)
      {
         extensions.Append (wxT(":"));
         extensions.Append (item->extensions[i]);
      }
   }
   if (item->mime_types.size() > 0)
   {
      mime_types.Append (item->mime_types[0]);
      for (unsigned int i = 1; i < item->mime_types.size(); i++)
      {
         mime_types.Append (wxT(":"));
         mime_types.Append (item->mime_types[i]);
      }
   }
 
   RuleTable->InsertRows (index, 1);
   RuleTable->SetCellValue (index, 0, extensions);
#if EXTIMPORT_MIME_SUPPORT
   RuleTable->SetCellValue (index, 1, mime_types);
#endif
   RuleTable->AutoSizeColumns ();
}

References ExtImportItem::extensions, ExtImportItem::mime_types, RuleTable, and wxT().

Referenced by OnAddRule(), and PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

Commit()

bool ExtImportPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 214 of file ExtImportPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   Importer::Get().WriteImportItems();
 
   return true;
}

References eIsSavingToPrefs, Importer::Get(), PopulateOrExchange(), S, and Importer::WriteImportItems().

Here is the call graph for this function:

DoOnPluginKeyDown()

bool ExtImportPrefs::DoOnPluginKeyDown ( int  code )

private

Definition at line 299 of file ExtImportPrefs.cpp.

{
   if (code != WXK_UP && code != WXK_DOWN)
         return false;
 
   long itemIndex = -1;
   long itemIndex2 = -1;
   itemIndex = PluginList->GetNextItem(itemIndex,
         wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
   if (itemIndex == -1)
         return false;
 
   if (last_selected == -1)
         return false;
 
   auto &items = Importer::Get().GetImportItems();
   ExtImportItem *item = items[last_selected].get();
 
   if (code == WXK_UP && itemIndex == 0)
      return false;
   else if (code == WXK_DOWN && itemIndex == PluginList->GetItemCount() - 1)
      return false;
 
   if (code == WXK_UP)
   {
      itemIndex2 = itemIndex - 1;
   }
   else if (code == WXK_DOWN)
   {
      itemIndex2 = itemIndex + 1;
   }
   SwapPluginRows (itemIndex, itemIndex2);
   if (mFakeKeyEvent)
   {
      PluginList->SetItemState (itemIndex, 0, wxLIST_STATE_SELECTED);
      PluginList->SetItemState (itemIndex2, wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED,
         wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
   }
   int fcount = item->filter_objects.size();
   if (item->divider >= fcount)
   {
      item->divider = -1;
   }
   if (item->divider < -1)
      item->divider = item->filter_objects.size() - 1;
 
   return true;
}

References ExtImportItem::divider, ExtImportItem::filter_objects, Importer::Get(), Importer::GetImportItems(), last_selected, mFakeKeyEvent, PluginList, and SwapPluginRows().

Referenced by OnPluginKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

DoOnRuleTableKeyDown()

void ExtImportPrefs::DoOnRuleTableKeyDown ( int  keycode )

private

Definition at line 411 of file ExtImportPrefs.cpp.

{
   int selrow = RuleTable->GetGridCursorRow ();
   wxString ts;
   if (keycode == WXK_UP)
   {
      if (selrow <= 0)
         return;
      SwapRows (selrow - 1, selrow);
      RuleTable->MoveCursorUp (false);
      RuleTable->SelectRow (selrow - 1);
   }
   else if (keycode == WXK_DOWN)
   {
      if (selrow == RuleTable->GetNumberRows() - 1)
         return;
      SwapRows (selrow, selrow + 1);
      RuleTable->MoveCursorDown (false);
      RuleTable->SelectRow (selrow + 1);
   }
}

References RuleTable, and SwapRows().

Referenced by OnRuleMoveDown(), OnRuleMoveUp(), and OnRuleTableKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

DoOnRuleTableSelect()

void ExtImportPrefs::DoOnRuleTableSelect ( int  toprow )

private

Definition at line 465 of file ExtImportPrefs.cpp.

{
   auto &items = Importer::Get().GetImportItems();
 
   if (toprow < 0 || toprow >= (int)items.size())
   {
      return;
   }
 
   ExtImportItem *item = items[toprow].get();
   PluginList->DeleteAllItems();
 
   int fcount;
   fcount = item->filters.size();
   int shift = 0;
   for (int i = 0; i < fcount; i++)
   {
      if (item->divider == i)
      {
         PluginList->InsertItem (i, _("Unused filters:"));
         PluginList->SetItemData (i, -1);
         shift = 1;
      }
      if (item->filter_objects[i] != NULL)
      {
         PluginList->InsertItem (i + shift,
               item->filter_objects[i]->GetPluginFormatDescription().Translation());
      }
      else
      {
         PluginList->InsertItem (i + shift, item->filters[i]);
      }
      PluginList->SetItemData (i + shift, i);
   }
   if (item->divider == -1)
   {
      PluginList->InsertItem (fcount, _("Unused filters:"));
      PluginList->SetItemData (fcount, -1);
   }
   wxListItem info;
   info.SetId (0);
   info.SetColumn (0);
   info.SetStateMask (wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
   info.SetState (wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
   info.SetMask (wxLIST_MASK_STATE);
   PluginList->SetItem (info);
   PluginList->SetColumnWidth (0, wxLIST_AUTOSIZE);
   last_selected = toprow;
}

References _, ExtImportItem::divider, ExtImportItem::filter_objects, ExtImportItem::filters, Importer::Get(), Importer::GetImportItems(), last_selected, and PluginList.

Referenced by OnDelRule(), OnRuleTableSelect(), and OnRuleTableSelectRange().

Here is the call graph for this function:

Here is the caller graph for this function:

FakeOnPluginKeyDown()

void ExtImportPrefs::FakeOnPluginKeyDown ( int  keycode )

private

Definition at line 675 of file ExtImportPrefs.cpp.

{
   wxListEvent fakeevent(wxEVT_COMMAND_LIST_KEY_DOWN, EIPPluginList);
   fakeevent.SetEventObject(this);
   fakeevent.m_code = keycode;
   mFakeKeyEvent = true;
   GetEventHandler()->ProcessEvent (fakeevent);
   mFakeKeyEvent = false;
}

References EIPPluginList, and mFakeKeyEvent.

Referenced by OnFilterMoveDown(), and OnFilterMoveUp().

Here is the caller graph for this function:

GetDescription()

TranslatableString ExtImportPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 82 of file ExtImportPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetDragFocus()

wxWindow * ExtImportPrefs::GetDragFocus ( )

inline

Definition at line 87 of file ExtImportPrefs.h.

{ return mDragFocus; }

References mDragFocus.

Referenced by ExtImportPrefsDropTarget::OnDragOver(), and ExtImportPrefsDropTarget::OnDrop().

Here is the caller graph for this function:

GetPluginList()

wxListCtrl * ExtImportPrefs::GetPluginList ( )

inline

Definition at line 85 of file ExtImportPrefs.h.

{ return PluginList; }

References PluginList.

Referenced by ExtImportPrefsDropTarget::OnDragOver(), and ExtImportPrefsDropTarget::OnDrop().

Here is the caller graph for this function:

GetRuleTable()

Grid * ExtImportPrefs::GetRuleTable ( )

inline

Definition at line 84 of file ExtImportPrefs.h.

{ return RuleTable; }

References RuleTable.

Referenced by ExtImportPrefsDropTarget::OnDragOver(), and ExtImportPrefsDropTarget::OnDrop().

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol ExtImportPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 77 of file ExtImportPrefs.cpp.

{
   return EXT_IMPORT_PREFS_PLUGIN_SYMBOL;
}

References EXT_IMPORT_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID ExtImportPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 87 of file ExtImportPrefs.cpp.

{
   return "Extended_Import_Preferences";
}

OnAddRule()

void ExtImportPrefs::OnAddRule

(

wxCommandEvent &

event

)

Definition at line 622 of file ExtImportPrefs.cpp.

{
   auto &items = Importer::Get().GetImportItems();
   auto uitem = Importer::Get().CreateDefaultImportItem();
   auto item = uitem.get();
   items.push_back(std::move(uitem));
   AddItemToTable (RuleTable->GetNumberRows (), item);
 
   RuleTable->SelectRow(RuleTable->GetNumberRows () - 1);
   RuleTable->SetGridCursor (RuleTable->GetNumberRows () - 1, 0);
   RuleTable->SetFocus();
}

References AddItemToTable(), Importer::CreateDefaultImportItem(), Importer::Get(), Importer::GetImportItems(), and RuleTable.

Here is the call graph for this function:

OnDelRule()

void ExtImportPrefs::OnDelRule

(

wxCommandEvent &

event

)

Definition at line 635 of file ExtImportPrefs.cpp.

{
   if (last_selected < 0)
      return;
   auto &items = Importer::Get().GetImportItems();
 
   int msgres = AudacityMessageBox (
      XO("Do you really want to delete selected rule?"),
      XO("Rule deletion confirmation"),
      wxYES_NO,
      RuleTable);
   // Yes or no, there is no third!
   if (msgres != wxYES)
      return;
 
   PluginList->DeleteAllItems();
   items.erase (items.begin() + last_selected);
   DoOnRuleTableSelect (last_selected);
   // This will change last_selected
   RuleTable->DeleteRows (last_selected);
   RuleTable->AutoSizeColumns ();
   if (last_selected >= RuleTable->GetNumberRows ())
      last_selected = RuleTable->GetNumberRows () - 1;
   if (last_selected >= 0)
   {
      RuleTable->SelectRow(last_selected);
      RuleTable->SetGridCursor (last_selected, 0);
   }
}

References AudacityMessageBox(), DoOnRuleTableSelect(), Importer::Get(), Importer::GetImportItems(), last_selected, PluginList, RuleTable, and XO().

Here is the call graph for this function:

OnFilterMoveDown()

void ExtImportPrefs::OnFilterMoveDown

(

wxCommandEvent &

event

)

Definition at line 690 of file ExtImportPrefs.cpp.

{
   FakeOnPluginKeyDown (WXK_DOWN);
}

References FakeOnPluginKeyDown().

Here is the call graph for this function:

OnFilterMoveUp()

void ExtImportPrefs::OnFilterMoveUp

(

wxCommandEvent &

event

)

Definition at line 685 of file ExtImportPrefs.cpp.

{
   FakeOnPluginKeyDown (WXK_UP);
}

References FakeOnPluginKeyDown().

Here is the call graph for this function:

OnNavKey()

void ExtImportPrefs::OnNavKey

(

wxNavigationKeyEvent &

event

)

OnPluginBeginDrag()

void ExtImportPrefs::OnPluginBeginDrag

(

wxListEvent &

event

)

Definition at line 375 of file ExtImportPrefs.cpp.

{
   wxDropSource dragSource(this);
   dragtext2->SetText(wxT(""));
   dragSource.SetData(*dragtext2);
   mDragFocus = PluginList;
   if( mDragFocus == NULL )
      return;
   wxDragResult result = dragSource.DoDragDrop(wxDrag_DefaultMove);
   mDragFocus = NULL;
   switch (result)
   {
      case wxDragCopy:
      case wxDragMove:
      case wxDragNone:
         return;
         break;
      default:
         break;
   }
}

References dragtext2, mDragFocus, PluginList, and wxT().

Here is the call graph for this function:

OnPluginKeyDown()

void ExtImportPrefs::OnPluginKeyDown

(

wxListEvent &

event

)

Definition at line 236 of file ExtImportPrefs.cpp.

{
   for (int i = 0; i < 1; i++)
   {
#ifdef __WXMAC__
      if (!mFakeKeyEvent && !wxGetKeyState(WXK_COMMAND))
         break;
#else
      if (!mFakeKeyEvent && !wxGetKeyState(WXK_CONTROL))
         break;
#endif
 
      if (DoOnPluginKeyDown (event.GetKeyCode()))
         event.Skip();
   }
}

References DoOnPluginKeyDown(), and mFakeKeyEvent.

Here is the call graph for this function:

OnRuleMoveDown()

void ExtImportPrefs::OnRuleMoveDown

(

wxCommandEvent &

event

)

Definition at line 670 of file ExtImportPrefs.cpp.

{
   DoOnRuleTableKeyDown (WXK_DOWN);
}

References DoOnRuleTableKeyDown().

Here is the call graph for this function:

OnRuleMoveUp()

void ExtImportPrefs::OnRuleMoveUp

(

wxCommandEvent &

event

)

Definition at line 665 of file ExtImportPrefs.cpp.

{
   DoOnRuleTableKeyDown (WXK_UP);
}

References DoOnRuleTableKeyDown().

Here is the call graph for this function:

OnRuleTableCellClick()

void ExtImportPrefs::OnRuleTableCellClick

(

wxGridEvent &

event

)

Definition at line 696 of file ExtImportPrefs.cpp.

{
   int row = event.GetRow();
   RuleTable->SelectRow (row, false);
   RuleTable->SetGridCursor (row, 0);
 
   wxDropSource dragSource(this);
   dragtext1->SetText(wxT(""));
   dragSource.SetData(*dragtext1);
   mDragFocus = RuleTable;
   wxDragResult result = dragSource.DoDragDrop(wxDrag_DefaultMove);
   mDragFocus = NULL;
   switch (result)
   {
      case wxDragCopy: /* copy the data */
      case wxDragMove:
      case wxDragNone:
         return;
         break;
      default:         /* do nothing */ break;
   }
 
   event.Skip();
}

References dragtext1, mDragFocus, RuleTable, and wxT().

Here is the call graph for this function:

OnRuleTableEdit()

void ExtImportPrefs::OnRuleTableEdit

(

wxGridEvent &

event

)

Definition at line 515 of file ExtImportPrefs.cpp.

{
   int row = event.GetRow();
   int col = event.GetCol();
   auto &items = Importer::Get().GetImportItems();
   ExtImportItem *item = items[row].get();
   RuleTable->SaveEditControlValue();
 
   wxString val = RuleTable->GetCellValue (row, col);
   int fixSpaces = wxNO;
   bool askedAboutSpaces = false;
   wxArrayString vals;
   wxString delims(wxT(":"));
   Importer::Get().StringToList (val, delims, vals);
   switch (col)
   {
   case 0:
      item->extensions.clear();
      break;
   case 1:
      item->mime_types.clear();
      break;
   }
 
   for (size_t i = 0; i < vals.size(); i++)
   {
 
      wxString trimmed = vals[i];
      trimmed.Trim().Trim(false);
      if (trimmed != vals[i])
      {
         if (!askedAboutSpaces)
         {
            fixSpaces = AudacityMessageBox(
               XO(
"There are space characters (spaces, newlines, tabs or linefeeds) in one of \
the items. They are likely to break the pattern matching. Unless you know \
what you are doing, it is recommended to trim spaces. Do you want \
Audacity to trim spaces for you?"),
               XO("Spaces detected"),
               wxYES_NO);
            askedAboutSpaces = true;
         }
         if (fixSpaces != wxYES)
         {
            trimmed = vals[i];
         }
         else
         {
            vals[i] = trimmed;
         }
      }
      switch (col)
      {
      case 0:
         item->extensions.push_back(trimmed);
         break;
      case 1:
         item->mime_types.push_back(trimmed);
         break;
      }
   }
   if (fixSpaces == wxYES)
   {
      wxString vals_as_string;
      for (size_t i = 0; i < vals.size(); i++)
      {
         if (i > 0)
            vals_as_string.Append (wxT(":"));
         vals_as_string.Append (vals[i]);
      }
      RuleTable->SetCellValue (row, col, vals_as_string);
   }
 
   RuleTable->AutoSizeColumns ();
}

References AudacityMessageBox(), ExtImportItem::extensions, Importer::Get(), Importer::GetImportItems(), ExtImportItem::mime_types, RuleTable, Importer::StringToList(), wxT(), and XO().

Here is the call graph for this function:

OnRuleTableKeyDown()

void ExtImportPrefs::OnRuleTableKeyDown

(

wxKeyEvent &

event

)

Definition at line 397 of file ExtImportPrefs.cpp.

{
   int mods = event.GetModifiers();
   if (mods & wxMOD_CMD && (event.GetKeyCode() == WXK_UP ||
          event.GetKeyCode() == WXK_DOWN))
   {
      DoOnRuleTableKeyDown (event.GetKeyCode());
   }
   else
   {
      event.Skip();
   }
}

References DoOnRuleTableKeyDown().

Here is the call graph for this function:

OnRuleTableSelect()

void ExtImportPrefs::OnRuleTableSelect

(

wxGridEvent &

event

)

Definition at line 433 of file ExtImportPrefs.cpp.

{
   int toprow;
   event.Skip();
   if (!event.Selecting() || mStopRecursiveSelection)
      return;
 
   toprow = event.GetRow();
   if (toprow < 0)
      return;
 
   DoOnRuleTableSelect (toprow);
}

References DoOnRuleTableSelect(), and mStopRecursiveSelection.

Here is the call graph for this function:

OnRuleTableSelectRange()

void ExtImportPrefs::OnRuleTableSelectRange

(

wxGridRangeSelectEvent &

event

)

Definition at line 447 of file ExtImportPrefs.cpp.

{
   int toprow;
   event.Skip();
   if (!event.Selecting() || mStopRecursiveSelection)
      return;
 
   toprow = event.GetTopRow();
   if (toprow < 0)
      return;
 
   DoOnRuleTableSelect (toprow);
   mStopRecursiveSelection = true;
   RuleTable->SelectRow (toprow);
   mStopRecursiveSelection = false;
   RuleTable->SetGridCursor (toprow, 0);
}

References DoOnRuleTableSelect(), mStopRecursiveSelection, and RuleTable.

Here is the call graph for this function:

OnShow()

void ExtImportPrefs::OnShow

(

wxShowEvent &

event

)

Definition at line 226 of file ExtImportPrefs.cpp.

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

References PluginList, and RuleTable.

Referenced by ExtImportPrefs().

Here is the caller graph for this function:

Populate()

void ExtImportPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 93 of file ExtImportPrefs.cpp.

{
   // Ensure Importer has current items
   Importer::Get().ReadImportItems();
 
   //------------------------- 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 --------------
}

References eIsCreatingFromPrefs, Importer::Get(), PopulateOrExchange(), Importer::ReadImportItems(), and S.

Here is the call graph for this function:

PopulateOrExchange()

void ExtImportPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 107 of file ExtImportPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.TieCheckBox(XXO("A&ttempt to use filter in OpenFile dialog first"),
         {wxT("/ExtendedImport/OverrideExtendedImportByOpenFileDialogChoice"),
          true});
   S.StartStatic(XO("Rules to choose import filters"), 1);
   {
      S.SetSizerProportion(1);
      S.StartHorizontalLay (wxEXPAND, 1);
      {
         bool fillRuleTable = false;
         if (RuleTable == NULL)
         {
            RuleTable = safenew Grid(FormatterContext::EmptyContext(), S.GetParent(),EIPRuleTable);
 
            RuleTable->SetColLabelSize(RuleTable->GetDefaultRowSize());
#if EXTIMPORT_MIME_SUPPORT
            RuleTable->CreateGrid (0, 2, wxGrid::wxGridSelectRows);
#else
            RuleTable->CreateGrid (0, 1, wxGrid::wxGridSelectRows);
#endif
            RuleTable->DisableDragColMove ();
            RuleTable->DisableDragRowSize ();
            RuleTable->SetDefaultCellAlignment(wxALIGN_LEFT, wxALIGN_CENTER);
            RuleTable->SetColLabelValue (0, _("File extensions"));
#if EXTIMPORT_MIME_SUPPORT
            RuleTable->SetColLabelValue (1, _("Mime-types"));
#endif
            RuleTable->SetRowLabelSize (0);
            RuleTable->SetSelectionMode (wxGrid::wxGridSelectRows);
            // call SetMinSize to enable scrolling on large content
            RuleTable->Fit();
            RuleTable->SetMinSize(RuleTable->GetSize());
 
            ExtImportPrefsDropTarget *dragtarget1 {};
            RuleTable->SetDropTarget (
               dragtarget1 = safenew ExtImportPrefsDropTarget(
                  dragtext1 = safenew wxTextDataObject(wxT(""))
               )
            );
            dragtarget1->SetPrefs (this);
 
            RuleTable->EnableDragCell (true);
            fillRuleTable = true;
         }
         S.Position(wxEXPAND | wxALL)
            .AddWindow(RuleTable);
 
         PluginList = S.Id(EIPPluginList).AddListControl(
            { { XO("Importer order"), wxLIST_FORMAT_LEFT,
                wxLIST_AUTOSIZE_USEHEADER } },
            wxLC_REPORT | wxLC_SINGLE_SEL
         );
 
         if (fillRuleTable)
         {
            ExtImportPrefsDropTarget *dragtarget2 {};
            PluginList->SetDropTarget (
               dragtarget2 = safenew ExtImportPrefsDropTarget(
                  dragtext2 = safenew wxTextDataObject(wxT(""))
               )
            );
            dragtarget2->SetPrefs (this);
 
            auto &items = Importer::Get().GetImportItems();
            {
               int i = -1;
               for (const auto &item : items)
                  AddItemToTable (++i, item.get());
            }
            if (!items.empty())
            {
               RuleTable->SelectRow(0);
               RuleTable->SetGridCursor(0,0);
            }
         }
      }
      S.EndHorizontalLay();
      S.StartHorizontalLay (wxSHRINK, 0);
      {
          MoveRuleUp = S.Id (EIPMoveRuleUp).AddButton(XXO("Move rule &up"));
          MoveRuleDown = S.Id (EIPMoveRuleDown).AddButton(
             XXO("Move rule &down"));
          MoveFilterUp = S.Id (EIPMoveFilterUp).AddButton(
             XXO("Move f&ilter up"));
          MoveFilterDown = S.Id (EIPMoveFilterDown).AddButton(
             XXO("Move &filter down"));
      }
      S.EndHorizontalLay();
      S.StartHorizontalLay (wxSHRINK, 0);
      {
          AddRule = S.Id (EIPAddRule).AddButton(XXO("&Add new rule"));
          DelRule = S.Id (EIPDelRule).AddButton(XXO("De&lete selected rule"));
      }
      S.EndHorizontalLay();
   }
   S.EndStatic();
   S.EndScroller();
 
   Layout();
   Fit();
   SetMinSize(GetSize());
}

References _, AddItemToTable(), AddRule, DelRule, dragtext1, dragtext2, EIPAddRule, EIPDelRule, EIPMoveFilterDown, EIPMoveFilterUp, EIPMoveRuleDown, EIPMoveRuleUp, EIPPluginList, EIPRuleTable, FormatterContext::EmptyContext(), Importer::Get(), Importer::GetImportItems(), MoveFilterDown, MoveFilterUp, MoveRuleDown, MoveRuleUp, PluginList, RuleTable, S, safenew, wxT(), XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

SwapPluginRows()

void ExtImportPrefs::SwapPluginRows	(	int	row1,
		int	row2
	)

Definition at line 253 of file ExtImportPrefs.cpp.

{
   wxString t, t2;
   long d, d2;
   ImportPlugin *ip1, *ip2;
 
   auto &items = Importer::Get().GetImportItems();
   ExtImportItem *item = NULL;
   if( last_selected >= 0 )
      item = items[last_selected].get();
 
   t = PluginList->GetItemText (row1);
   d = PluginList->GetItemData (row1);
   d2 = PluginList->GetItemData (row2);
   PluginList->SetItemText (row1, PluginList->GetItemText (row2));
   PluginList->SetItemText (row2, t);
   if (d == -1 || d2 == -1)
   {
      PluginList->SetItemData (row1, PluginList->GetItemData (row2));
      PluginList->SetItemData (row2, d);
      if( !item )
         return;
      if (d == -1)
      {
         item->divider = row2;
      }
      else if (d2 == -1)
      {
         item->divider = row1;
      }
   }
   else
   {
      if( !item )
         return;
      ip1 = item->filter_objects[d];
      ip2 = item->filter_objects[d2];
      item->filter_objects[d] = ip2;
      item->filter_objects[d2] = ip1;
      t = item->filters[d];
      t2 = item->filters[d2];
      item->filters[d] = t2;
      item->filters[d2] = t;
   }
}

References ExtImportItem::divider, ExtImportItem::filter_objects, ExtImportItem::filters, Importer::Get(), Importer::GetImportItems(), last_selected, and PluginList.

Referenced by DoOnPluginKeyDown(), and ExtImportPrefsDropTarget::OnDragOver().

Here is the call graph for this function:

Here is the caller graph for this function:

SwapRows()

void ExtImportPrefs::SwapRows	(	int	row1,
		int	row2
	)

Definition at line 349 of file ExtImportPrefs.cpp.

{
   int t;
   wxString ts;
   if (row1 == row2)
      return;
   if (row1 > row2)
   {
      t = row1;
      row1 = row2;
      row2 = t;
   }
   auto &items = Importer::Get().GetImportItems();
 
   auto &t1 = items[row1];
   auto &t2 = items[row2];
   std::swap(t1, t2);
 
   for (int i = 0; i < RuleTable->GetNumberCols(); i++)
   {
      ts = RuleTable->GetCellValue (row2, i);
      RuleTable->SetCellValue (row2, i, RuleTable->GetCellValue (row1, i));
      RuleTable->SetCellValue (row1, i, ts);
   }
}

References Importer::Get(), Importer::GetImportItems(), RuleTable, and anonymous_namespace{NoteTrack.cpp}::swap().

Referenced by DoOnRuleTableKeyDown(), and ExtImportPrefsDropTarget::OnDragOver().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

AddRule

wxButton* ExtImportPrefs::AddRule

private

Definition at line 94 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

DelRule

wxButton* ExtImportPrefs::DelRule

private

Definition at line 95 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

dragtext1

wxTextDataObject* ExtImportPrefs::dragtext1 {}

private

Definition at line 101 of file ExtImportPrefs.h.

Referenced by OnRuleTableCellClick(), and PopulateOrExchange().

dragtext2

wxTextDataObject* ExtImportPrefs::dragtext2 {}

private

Definition at line 102 of file ExtImportPrefs.h.

Referenced by OnPluginBeginDrag(), and PopulateOrExchange().

last_selected

int ExtImportPrefs::last_selected

private

Definition at line 109 of file ExtImportPrefs.h.

Referenced by DoOnPluginKeyDown(), DoOnRuleTableSelect(), OnDelRule(), and SwapPluginRows().

mCreateTable

bool ExtImportPrefs::mCreateTable

private

Definition at line 104 of file ExtImportPrefs.h.

mDragFocus

wxWindow* ExtImportPrefs::mDragFocus

private

Definition at line 105 of file ExtImportPrefs.h.

Referenced by GetDragFocus(), OnPluginBeginDrag(), and OnRuleTableCellClick().

mFakeKeyEvent

bool ExtImportPrefs::mFakeKeyEvent

private

Definition at line 106 of file ExtImportPrefs.h.

Referenced by DoOnPluginKeyDown(), FakeOnPluginKeyDown(), and OnPluginKeyDown().

MoveFilterDown

wxButton* ExtImportPrefs::MoveFilterDown

private

Definition at line 99 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

MoveFilterUp

wxButton* ExtImportPrefs::MoveFilterUp

private

Definition at line 98 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

MoveRuleDown

wxButton* ExtImportPrefs::MoveRuleDown

private

Definition at line 97 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

MoveRuleUp

wxButton* ExtImportPrefs::MoveRuleUp

private

Definition at line 96 of file ExtImportPrefs.h.

Referenced by PopulateOrExchange().

mStopRecursiveSelection

bool ExtImportPrefs::mStopRecursiveSelection

private

Definition at line 107 of file ExtImportPrefs.h.

Referenced by OnRuleTableSelect(), and OnRuleTableSelectRange().

PluginList

wxListCtrl* ExtImportPrefs::PluginList

private

Definition at line 92 of file ExtImportPrefs.h.

Referenced by DoOnPluginKeyDown(), DoOnRuleTableSelect(), GetPluginList(), OnDelRule(), OnPluginBeginDrag(), OnShow(), PopulateOrExchange(), and SwapPluginRows().

RuleTable

Grid* ExtImportPrefs::RuleTable

private

Definition at line 91 of file ExtImportPrefs.h.

Referenced by AddItemToTable(), DoOnRuleTableKeyDown(), GetRuleTable(), OnAddRule(), OnDelRule(), OnRuleTableCellClick(), OnRuleTableEdit(), OnRuleTableSelectRange(), OnShow(), PopulateOrExchange(), and SwapRows().

---

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

• ExtImportPrefs.h
• ExtImportPrefs.cpp