GetInfoCommand Class Reference

Command which outputs a list of available menu commands on the status channel. More...

#include <GetInfoCommand.h>

Inheritance diagram for GetInfoCommand:

Collaboration diagram for GetInfoCommand:

Public Member Functions
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)
bool	VisitSettings (SettingsVisitor &S) override
bool	VisitSettings (ConstSettingsVisitor &S) override
void	PopulateOrExchange (ShuttleGui &S) override
ManualPageID	ManualPage () override
bool	Apply (const CommandContext &context) override
bool	ApplyInner (const CommandContext &context)
Public Member Functions inherited from AudacityCommand
	AudacityCommand ()
virtual	~AudacityCommand ()
PluginPath	GetPath () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
ComponentInterfaceSymbol	GetSymbol () const override=0
virtual TranslatableString	GetDescription () const override
virtual ManualPageID	ManualPage ()
virtual bool	IsBatchProcessing () const
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog *	CreateUI (wxWindow *parent, AudacityCommand *client)
bool	SaveSettingsAsString (wxString &parms)
bool	LoadSettingsFromString (const wxString &parms)
bool	DoAudacityCommand (const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool	Init ()
virtual bool	PromptUser (AudacityProject &)
virtual bool	CheckWhetherSkipAudacityCommand ()
virtual void	End ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool	TransferDataToWindow ()
virtual bool	TransferDataFromWindow ()
virtual bool	VisitSettings (SettingsVisitor &)
virtual bool	VisitSettings (ConstSettingsVisitor &)
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const

Public Attributes
int	mInfoType
int	mFormat

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Get Info") }

Private Member Functions
bool	SendCommands (const CommandContext &context, int flags)
bool	SendMenus (const CommandContext &context)
bool	SendPreferences (const CommandContext &context)
bool	SendTracks (const CommandContext &context)
bool	SendLabels (const CommandContext &context)
bool	SendClips (const CommandContext &context)
bool	SendEnvelopes (const CommandContext &context)
bool	SendBoxes (const CommandContext &context)
bool	SendSelection (const CommandContext &context)
void	ExploreMenu (const CommandContext &context, wxMenu *pMenu, int Id, int depth)
void	ExploreTrackPanel (const CommandContext &context, wxPoint P, int depth)
void	ExploreAdornments (const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)
void	ExploreWindows (const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)

Additional Inherited Members
Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Detailed Description

Command which outputs a list of available menu commands on the status channel.

Definition at line 29 of file GetInfoCommand.h.

Member Function Documentation

Apply()

bool GetInfoCommand::Apply ( const CommandContext &  context )

override

Definition at line 142 of file GetInfoCommand.cpp.

{
   if( mFormat == kJson )
      return ApplyInner( context );
 
   if( mFormat == kLisp )
   {
      CommandContext LispyContext(
         context.project,
         std::make_unique<LispifiedCommandOutputTargets>( *context.pOutput.get() )
         );
      return ApplyInner( LispyContext );
   }
 
   if( mFormat == kBrief )
   {
      CommandContext BriefContext(
         context.project,
         std::make_unique<BriefCommandOutputTargets>( *context.pOutput.get() )
         );
      return ApplyInner( BriefContext );
   }
 
   return false;
}

References ApplyInner(), kBrief, kJson, kLisp, mFormat, CommandContext::pOutput, and CommandContext::project.

Here is the call graph for this function:

ApplyInner()

bool GetInfoCommand::ApplyInner

(

const CommandContext &

context

)

Definition at line 168 of file GetInfoCommand.cpp.

{
   switch( mInfoType  ){
      // flag of 1 to include parameterless commands.
      case kCommands     : return SendCommands( context, 1 );
      case kMenus        : return SendMenus( context );
      case kPreferences  : return SendPreferences( context );
      case kTracks       : return SendTracks( context );
      case kClips        : return SendClips( context );
      case kEnvelopes    : return SendEnvelopes( context );
      case kLabels       : return SendLabels( context );
      case kBoxes        : return SendBoxes( context );
      case kSelection    : return SendSelection( context );
      default:
         context.Status( "Command options not recognised" );
   }
   return false;
}

References kBoxes, kClips, kCommands, kEnvelopes, kLabels, kMenus, kPreferences, kSelection, kTracks, mInfoType, SendBoxes(), SendClips(), SendCommands(), SendEnvelopes(), SendLabels(), SendMenus(), SendPreferences(), SendSelection(), SendTracks(), and CommandContext::Status().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

ExploreAdornments()

void GetInfoCommand::ExploreAdornments ( const CommandContext &  context, wxPoint  P, wxWindow *  pWin, int  Id, int  depth  )

private

Definition at line 703 of file GetInfoCommand.cpp.

{
   // Dang! wxMenuBar returns bogus screen rect.
   // We're going to have to fake it instead.
   //wxMenuBar * pBar = context.GetProject()->GetMenuBar();
   //wxRect R = pBar->GetScreenRect();
   //R.SetPosition( R.GetPosition() - P );
 
   wxRect R1 = pWin->GetScreenRect();
   wxSize s = pWin->GetWindowBorderSize();
   wxRect R( 2,32, R1.GetWidth() - s.GetWidth() * 2 -16, 22 );
 
   context.StartStruct();
   context.AddItem( depth, "depth" );
   context.AddItem( "MenuBar", "label" );
   context.StartField( "box" );
   context.StartArray();
   context.AddItem( R.GetLeft() );
   context.AddItem( R.GetTop() );
   context.AddItem( R.GetRight() );
   context.AddItem( R.GetBottom() );
   context.EndArray();
   context.EndField();
   context.EndStruct();
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndField(), CommandContext::EndStruct(), CommandContext::StartArray(), CommandContext::StartField(), and CommandContext::StartStruct().

Here is the call graph for this function:

ExploreMenu()

void GetInfoCommand::ExploreMenu ( const CommandContext &  context, wxMenu *  pMenu, int  Id, int  depth  )

private

Definition at line 654 of file GetInfoCommand.cpp.

                                                                                                  {
   static_cast<void>(Id);//compiler food.
   if( !pMenu )
      return;
 
   auto &commandManager = CommandManager::Get( context.project );
 
   wxMenuItemList list = pMenu->GetMenuItems();
   size_t lcnt = list.size();
   wxMenuItem * item;
   wxString Label;
   wxString Accel;
   CommandID Name;
 
   for (size_t lndx = 0; lndx < lcnt; lndx++) {
      item = list.Item(lndx)->GetData();
      Label = item->GetItemLabelText();
      Name = commandManager.GetNameFromNumericID( item->GetId() );
      Accel = item->GetItemLabel();
      if( Accel.Contains("\t") )
         Accel = Accel.AfterLast('\t');
      else
         Accel = "";
      if( item->IsSeparator() )
         Label = "----";
      int flags = 0;
      if (item->IsSubMenu())
         flags +=1;
      if (item->IsCheck() && item->IsChecked())
         flags +=2;
 
      context.StartStruct();
      context.AddItem( depth, "depth" );
      context.AddItem( flags, "flags" );
      context.AddItem( Label, "label" );
      context.AddItem( Accel, "accel" );
      if( !Name.empty() )
         // using GET to expose CommandID in results of GetInfoCommand...
         // PRL asks, is that all right?
         context.AddItem( Name.GET(), "id" );// It is called Scripting ID outside Audacity.
      context.EndStruct();
 
      if (item->IsSubMenu()) {
         pMenu = item->GetSubMenu();
         ExploreMenu( context, pMenu, item->GetId(), depth+1 );
      }
   }
}

References CommandContext::AddItem(), CommandContext::EndStruct(), CommandManager::Get(), CommandContext::project, and CommandContext::StartStruct().

Referenced by SendMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

ExploreTrackPanel()

void GetInfoCommand::ExploreTrackPanel ( const CommandContext &  context, wxPoint  P, int  depth  )

private

Definition at line 730 of file GetInfoCommand.cpp.

{
   AudacityProject * pProj = &context.project;
   auto &tp = TrackPanel::Get( *pProj );
   wxRect panelRect{ {}, tp.GetSize() };
   for (auto pTrack : TrackList::Get(*pProj)) {
      for (auto pChannel : pTrack->Channels()) {
         auto rulers = tp.FindRulerRects(*pChannel);
         for (auto &R : rulers) {
            if (!R.Intersects(panelRect))
               continue;
            R.SetPosition( R.GetPosition() + P );
            context.StartStruct();
            context.AddItem( depth, "depth" );
            context.AddItem( "VRuler", "label" );
            context.StartField("box");
            context.StartArray();
            context.AddItem( R.GetLeft() );
            context.AddItem( R.GetTop() );
            context.AddItem( R.GetRight() );
            context.AddItem( R.GetBottom() );
            context.EndArray();
            context.EndField();
            context.EndStruct();
         }
      }
   }
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndField(), CommandContext::EndStruct(), TrackList::Get(), TrackPanel::Get(), P, CommandContext::project, CommandContext::StartArray(), CommandContext::StartField(), and CommandContext::StartStruct().

Here is the call graph for this function:

ExploreWindows()

void GetInfoCommand::ExploreWindows ( const CommandContext &  context, wxPoint  P, wxWindow *  pWin, int  Id, int  depth  )

private

Definition at line 761 of file GetInfoCommand.cpp.

{
   static_cast<void>(Id);//Compiler food.
 
   if( pWin->GetName() == "Track Panel" )
   {
      wxRect R = pWin->GetScreenRect();
      ExploreTrackPanel(  context, R.GetPosition()-P, depth );
      return;
   }
   wxWindowList list = pWin->GetChildren();
   size_t lcnt = list.size();
 
   for (size_t lndx = 0; lndx < lcnt; lndx++) {
      wxWindow * item = list[lndx];
      if( !item->IsShown() )
         continue;
      wxRect R = item->GetScreenRect();
      R.SetPosition( R.GetPosition() - P );
      wxString Name = item->GetName();
      // Ignore staticLine and StaticBitmap.
      if( Name.StartsWith( "static" ) )
         continue;
      // Ignore anonymous panels.
      if( Name == "panel"  )
         continue;
      if( Name.empty() )
         Name = wxString("*") + item->GetToolTipText();
 
      context.StartStruct();
      context.AddItem( depth, "depth" );
      context.AddItem( Name, "label" );
      context.AddItem( item->GetId(), "id" );
      context.StartField( "box" );
      context.StartArray();
      context.AddItem( R.GetLeft() );
      context.AddItem( R.GetTop() );
      context.AddItem( R.GetRight() );
      context.AddItem( R.GetBottom() );
      context.EndArray();
      context.EndField();
      context.EndStruct();
 
      ExploreWindows( context, P, item, item->GetId(), depth+1 );
   }
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndField(), CommandContext::EndStruct(), P, CommandContext::StartArray(), CommandContext::StartField(), and CommandContext::StartStruct().

Here is the call graph for this function:

GetDescription()

TranslatableString GetInfoCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 36 of file GetInfoCommand.h.

{return XO("Gets information in JSON format.");};

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol GetInfoCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 35 of file GetInfoCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID GetInfoCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 43 of file GetInfoCommand.h.

{return L"Extra_Menu:_Scriptables_II#get_info";}

PopulateOrExchange()

void GetInfoCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 128 of file GetInfoCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieChoice( XXO("Type:"),
         mInfoType, Msgids( kTypes, nTypes ));
      S.TieChoice( XXO("Format:"),
         mFormat, Msgids( kFormats, nFormats ));
   }
   S.EndMultiColumn();
}

References kFormats, kTypes, mFormat, mInfoType, Msgids(), nFormats, nTypes, S, and XXO().

Here is the call graph for this function:

SendBoxes()

bool GetInfoCommand::SendBoxes ( const CommandContext &  context )

private

Definition at line 448 of file GetInfoCommand.cpp.

{
   //context.Status("Boxes");
   auto pWin = &GetProjectFrame( context.project );
 
   context.StartArray();
   wxRect R = pWin->GetScreenRect();
 
   //R.SetPosition( wxPoint(0,0) );
 
   //wxString Name = pWin->GetName();
   context.StartStruct();
   context.AddItem( 0, "depth" );
   context.AddItem( "Audacity Window", "name" );
   context.StartField( "box" );
   context.StartArray( );
   context.AddItem( R.GetLeft() );
   context.AddItem( R.GetTop() );
   context.AddItem( R.GetRight() );
   context.AddItem( R.GetBottom() );
   context.EndArray( );
   context.EndField();
   context.EndStruct( );
 
   ExploreAdornments( context, pWin->GetPosition()+wxSize( 6,-1), pWin, pWin->GetId(), 1 );
   ExploreWindows( context, pWin->GetPosition()+wxSize( 6,-1), pWin, pWin->GetId(), 1 );
   context.EndArray( );
   return true;
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndField(), CommandContext::EndStruct(), GetProjectFrame(), CommandContext::project, CommandContext::StartArray(), CommandContext::StartField(), and CommandContext::StartStruct().

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendClips()

bool GetInfoCommand::SendClips ( const CommandContext &  context )

private

Definition at line 525 of file GetInfoCommand.cpp.

{
   auto &tracks = TrackList::Get( context.project );
   int i=0;
   context.StartArray();
   for (auto t : tracks) {
      t->TypeSwitch([&](WaveTrack &waveTrack) {
         for (const auto pInterval : waveTrack.Intervals()) {
            context.StartStruct();
            context.AddItem((double)i, "track");
            context.AddItem(pInterval->GetPlayStartTime(), "start");
            context.AddItem(pInterval->GetPlayEndTime(), "end");
            // Assuming same colors, look at only left channel
            const auto &colors =
               WaveColorAttachment::Get(**pInterval->Channels().begin());
            context.AddItem(colors.GetColorIndex(), "color");
            context.AddItem(pInterval->GetName(), "name");
            context.EndStruct();
         }
      });
      // Per track numbering counts all tracks
      i++;
   }
   context.EndArray();
 
   return true;
}

References CommandContext::EndArray(), TrackList::Get(), WaveTrack::Intervals(), CommandContext::project, CommandContext::StartArray(), and tracks.

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendCommands()

bool GetInfoCommand::SendCommands ( const CommandContext &  context, int  flags  )

private

Send the list of commands.

Definition at line 430 of file GetInfoCommand.cpp.

{
   context.StartArray();
   PluginManager & pm = PluginManager::Get();
   {
      for (auto &plug
           : pm.PluginsOfType(PluginTypeEffect | PluginTypeAudacityCommand)) {
         auto command = pm.GetCommandIdentifier(plug.GetID());
         if (!command.empty()){
            EffectAndCommandPluginManager::Get().GetCommandDefinition(
               plug.GetID(), context, flags);
         }
      }
   }
   context.EndArray();
   return true;
}

References CommandContext::EndArray(), PluginManager::Get(), EffectAndCommandPluginManager::Get(), EffectAndCommandPluginManager::GetCommandDefinition(), PluginManager::GetCommandIdentifier(), PluginManager::PluginsOfType(), PluginTypeAudacityCommand, PluginTypeEffect, and CommandContext::StartArray().

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendEnvelopes()

bool GetInfoCommand::SendEnvelopes ( const CommandContext &  context )

private

Definition at line 553 of file GetInfoCommand.cpp.

{
   auto &tracks = TrackList::Get( context.project );
   int i=0;
   int j=0;
   context.StartArray();
   for (auto t : tracks) {
      t->TypeSwitch([&](WaveTrack &waveTrack) {
         auto ptrs = waveTrack.SortedIntervalArray();
         j = 0;
         for (auto &pClip : ptrs) {
            context.StartStruct();
            context.AddItem((double)i, "track");
            context.AddItem((double)j, "clip");
            context.AddItem(pClip->GetPlayStartTime(), "start");
            const auto pEnv = &pClip->GetEnvelope();
            context.StartField("points");
            context.StartArray();
            double offset = pEnv->GetOffset();
            for (size_t k = 0; k < pEnv->GetNumberOfPoints(); k++)
            {
               context.StartStruct();
               context.AddItem((*pEnv)[k].GetT() + offset, "t");
               context.AddItem((*pEnv)[k].GetVal(), "y");
               context.EndStruct();
            }
            context.EndArray();
            context.EndField();
            context.AddItem(pClip->GetPlayEndTime(), "end");
            context.EndStruct();
            j++;
         }
      });
      // Per track numbering counts all tracks
      i++;
   }
   context.EndArray();
 
   return true;
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndField(), CommandContext::EndStruct(), for(), TrackList::Get(), CommandContext::project, WaveTrack::SortedIntervalArray(), CommandContext::StartArray(), CommandContext::StartField(), CommandContext::StartStruct(), and tracks.

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendLabels()

bool GetInfoCommand::SendLabels ( const CommandContext &  context )

private

Definition at line 595 of file GetInfoCommand.cpp.

{
   auto &tracks = TrackList::Get( context.project );
   int i=0;
   context.StartArray();
   for (auto t : tracks) {
      t->TypeSwitch( [&](LabelTrack &labelTrack) {
#ifdef VERBOSE_LABELS_FORMATTING
         for (int nn = 0; nn< (int)labelTrack->mLabels.size(); nn++) {
            const auto &label = labelTrack->mLabels[nn];
            context.StartStruct();
            context.AddItem( (double)i, "track" );
            context.AddItem( label.getT0(), "start" );
            context.AddItem( label.getT1(), "end" );
            context.AddItem( label.title, "text" );
            context.EndStruct();
         }
#else
         context.StartArray();
         context.AddItem( (double)i ); // Track number.
         context.StartArray();
         for ( const auto &label : labelTrack.GetLabels() ) {
            context.StartArray();
            context.AddItem( label.getT0() ); // start
            context.AddItem( label.getT1() ); // end
            context.AddItem( label.title ); //text.
            context.EndArray();
         }
         context.EndArray();
         context.EndArray();
#endif
      } );
      // Per track numbering counts all tracks
      i++;
   }
   context.EndArray();
 
   return true;
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndStruct(), TrackList::Get(), LabelTrack::GetLabels(), label, LabelTrack::mLabels, CommandContext::project, CommandContext::StartArray(), CommandContext::StartStruct(), and tracks.

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendMenus()

bool GetInfoCommand::SendMenus ( const CommandContext &  context )

private

Definition at line 187 of file GetInfoCommand.cpp.

{
   wxMenuBar * pBar = GetProjectFrame( context.project ).GetMenuBar();
   if(!pBar ){
      wxLogDebug("No menus");
      return false;
   }
 
   size_t cnt = pBar->GetMenuCount();
   size_t i;
   wxString Label;
   context.StartArray();
   for(i=0;i<cnt;i++)
   {
      Label = pBar->GetMenuLabelText( i );
      context.StartStruct();
      context.AddItem( 0, "depth" );
      context.AddItem( 0, "flags" );
      context.AddItem( Label, "label" );
      context.AddItem( "", "accel" );
      context.EndStruct();
      ExploreMenu( context, pBar->GetMenu( i ), pBar->GetId(), 1 );
   }
   context.EndArray();
   return true;
}

References CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndStruct(), ExploreMenu(), GetProjectFrame(), CommandContext::project, CommandContext::StartArray(), and CommandContext::StartStruct().

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendPreferences()

bool GetInfoCommand::SendPreferences ( const CommandContext &  context )

private

Definition at line 414 of file GetInfoCommand.cpp.

{
   context.StartArray();
   auto pWin = &GetProjectFrame( context.project );
   GlobalPrefsDialog dialog( pWin, &context.project );
   // wxCommandEvent Evt;
   //dialog.Show();
   ShuttleGuiGetDefinition S(pWin, *((context.pOutput)->mStatusTarget) );
    dialog.ShuttleAll( S );
   context.EndArray();
   return true;
}

References CommandContext::EndArray(), GetProjectFrame(), CommandContext::pOutput, CommandContext::project, S, PrefsDialog::ShuttleAll(), and CommandContext::StartArray().

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendSelection()

bool GetInfoCommand::SendSelection ( const CommandContext &  context )

private

Definition at line 635 of file GetInfoCommand.cpp.

{
   context.StartStruct();
 
   const auto& selectedRegion = ViewInfo::Get( context.project ).selectedRegion;
 
   context.AddItem(selectedRegion.t0(), "Start");  // Send selection start position
   context.AddItem(selectedRegion.t1(), "End");    // Send cselection end position
 
   context.EndStruct();
 
   return true;
}

References CommandContext::AddItem(), CommandContext::EndStruct(), ViewInfo::Get(), CommandContext::project, ViewInfo::selectedRegion, and CommandContext::StartStruct().

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

SendTracks()

bool GetInfoCommand::SendTracks ( const CommandContext &  context )

private

Definition at line 478 of file GetInfoCommand.cpp.

{
   auto &tracks = TrackList::Get( context.project );
   context.StartArray();
   for (auto trk : tracks)
   {
      auto &trackFocus = TrackFocus::Get( context.project );
      Track * fTrack = trackFocus.Get();
 
      context.StartStruct();
      context.AddItem( trk->GetName(), "name" );
      context.AddBool( (trk == fTrack), "focused");
      context.AddBool( trk->GetSelected(), "selected" );
      //JKC: Possibly add later...
      //context.AddItem(ChannelView::GetChannelGroupHeight(*trk), "height");
      trk->TypeSwitch( [&] (const WaveTrack &t) {
         float vzmin, vzmax;
         WaveformScale::Get(t).GetDisplayBounds(vzmin, vzmax);
         context.AddItem( "wave", "kind" );
         context.AddItem( t.GetStartTime(), "start" );
         context.AddItem( t.GetEndTime(), "end" );
         context.AddItem( t.GetPan() , "pan");
         context.AddItem( t.GetVolume() , "volume");
         context.AddItem( t.NChannels(), "channels");
         context.AddBool( t.GetSolo(), "solo" );
         context.AddBool( t.GetMute(), "mute");
         context.AddItem( vzmin, "VZoomMin");
         context.AddItem( vzmax, "VZoomMax");
      },
#if defined(USE_MIDI)
      [&](const NoteTrack &) {
         context.AddItem( "note", "kind" );
      },
#endif
      [&](const LabelTrack &) {
         context.AddItem( "label", "kind" );
      },
      [&](const TimeTrack &) {
         context.AddItem( "time", "kind" );
      }
      );
      context.EndStruct();
   }
   context.EndArray();
   return true;
}

References CommandContext::AddBool(), CommandContext::AddItem(), CommandContext::EndArray(), CommandContext::EndStruct(), TrackFocus::Get(), TrackList::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), WaveformScale::Get(), WaveformScale::GetDisplayBounds(), WaveTrack::GetEndTime(), WaveTrack::GetMute(), WaveTrack::GetPan(), WaveTrack::GetSolo(), WaveTrack::GetStartTime(), WaveTrack::GetVolume(), WaveTrack::NChannels(), CommandContext::project, CommandContext::StartArray(), CommandContext::StartStruct(), and tracks.

Referenced by ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

VisitSettings() [1/3]

bool GetInfoCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 125 of file GetInfoCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool GetInfoCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 122 of file GetInfoCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool GetInfoCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 116 of file GetInfoCommand.cpp.

                                                                  {
   S.DefineEnum( mInfoType, wxT("Type"), 0, kTypes, nTypes );
   S.DefineEnum( mFormat, wxT("Format"), 0, kFormats, nFormats );
   return true;
}

References kFormats, kTypes, mFormat, mInfoType, nFormats, nTypes, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

mFormat

int GetInfoCommand::mFormat

Definition at line 49 of file GetInfoCommand.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

mInfoType

int GetInfoCommand::mInfoType

Definition at line 48 of file GetInfoCommand.h.

Referenced by ApplyInner(), PopulateOrExchange(), and VisitSettings().

Symbol

const ComponentInterfaceSymbol GetInfoCommand::Symbol { XO("Get Info") }

static

Definition at line 32 of file GetInfoCommand.h.

Referenced by GetSymbol().

---

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

• GetInfoCommand.h
• GetInfoCommand.cpp