Command that sets clip information. More...

#include <DragCommand.h>

Inheritance diagram for DragCommand:

Collaboration diagram for DragCommand:

Public Member Functions
	DragCommand ()

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

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
double	mFromX

double	mFromY

double	mToX

double	mToY

int	mRelativeTo

int	mId

wxString	mWinName

bool	bHasFromX

bool	bHasFromY

bool	bHasToX

bool	bHasToY

bool	bHasRelativeTo

bool	bHasId

bool	bHasWinName

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

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 that sets clip information.

Definition at line 22 of file DragCommand.h.

Constructor & Destructor Documentation

◆ DragCommand()

DragCommand::DragCommand ( )

Definition at line 40 of file DragCommand.cpp.

41{

42}

Member Function Documentation

◆ Apply()

bool DragCommand::Apply ( const CommandContext & context )

override

Definition at line 99 of file DragCommand.cpp.

{
   // Defaults if no value...
   if( !bHasFromX )
      mFromX = 200.0;
   if( !bHasFromY )
      mFromY = 10;
   if( !bHasToX )
      mToX = 400;
   if( !bHasToY )
      mToY = 10;
 
   wxWindow * pWin = &GetProjectFrame( context.project );
   wxWindow * pWin1 = nullptr;
   wxMouseEvent Evt( wxEVT_MOTION );
   Evt.m_x = mFromX;
   Evt.m_y = mFromY;
   if( bHasId )
      pWin1 = pWin->FindWindowById( mId );
   if( bHasWinName )
      pWin1 = pWin->FindWindowByName( mWinName );
   if( pWin1 )
      pWin = pWin1;
   // Process twice - possible bug in Audacity being worked around
   // where we need an event to enter AND an event to move.
   // AdornedRuler Quick-Play bug.
   pWin->GetEventHandler()->ProcessEvent( Evt );
   pWin->GetEventHandler()->ProcessEvent( Evt );
   if( bHasToX ){
      wxMouseEvent Evt2( wxEVT_LEFT_DOWN );
      Evt2.m_leftDown = true;
      Evt2.m_x = mFromX;
      Evt2.m_y = mFromY;
      Evt2.m_aux2Down = true;
      pWin->GetEventHandler()->ProcessEvent( Evt2 );
      wxMouseEvent Evt3( wxEVT_MOTION );
      Evt3.m_leftDown = true;
      Evt2.m_aux2Down = true;
      Evt3.m_x = mToX;
      Evt3.m_y = mToY;
      // AdornedRuler Quick-Play bug again.
      pWin->GetEventHandler()->ProcessEvent( Evt3 );
      pWin->GetEventHandler()->ProcessEvent( Evt3 );
      wxMouseEvent Evt4( wxEVT_LEFT_UP );
      Evt2.m_aux2Down = true;
      Evt4.m_x = mToX;
      Evt4.m_y = mToY;
      pWin->GetEventHandler()->ProcessEvent( Evt4 );
   }
   return true;
}

References bHasFromX, bHasFromY, bHasId, bHasToX, bHasToY, bHasWinName, GetProjectFrame(), mFromX, mFromY, mId, mToX, mToY, mWinName, and CommandContext::project.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString DragCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 30 of file DragCommand.h.

30{return XO("Drags mouse from one place to another.");};

XO

XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol DragCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 29 of file DragCommand.h.

29{return Symbol;};

DragCommand::Symbol

static const ComponentInterfaceSymbol Symbol

Definition: DragCommand.h:25

References Symbol.

◆ ManualPage()

ManualPageID DragCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 37 of file DragCommand.h.

37{return L"Extra_Menu:_Scriptables_II#move_mouse";}

◆ PopulateOrExchange()

void DragCommand::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 80 of file DragCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxALIGN_CENTER);
   {
      /* i18n-hint abbreviates "Identity" or "Identifier" */
      S.Optional( bHasId         ).TieNumericTextBox(  XXO("Id:"),          mId );
      S.Optional( bHasWinName    ).TieTextBox(         XXO("Window Name:"), mWinName );
      S.Optional( bHasFromX      ).TieNumericTextBox(  XXO("From X:"),      mFromX );
      S.Optional( bHasFromY      ).TieNumericTextBox(  XXO("From Y:"),      mFromY );
      S.Optional( bHasToX        ).TieNumericTextBox(  XXO("To X:"),        mToX );
      S.Optional( bHasToY        ).TieNumericTextBox(  XXO("To Y:"),        mToY );
      S.Optional( bHasRelativeTo ).TieChoice(          XXO("Relative To:"), mRelativeTo,
         Msgids( kCoordTypeStrings, nCoordTypes ) );
   }
   S.EndMultiColumn();
}

References bHasFromX, bHasFromY, bHasId, bHasRelativeTo, bHasToX, bHasToY, bHasWinName, kCoordTypeStrings, mFromX, mFromY, mId, mRelativeTo, Msgids(), mToX, mToY, mWinName, nCoordTypes, S, and XXO().

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool DragCommand::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 77 of file DragCommand.cpp.

78 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool DragCommand::VisitSettings ( SettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 74 of file DragCommand.cpp.

75 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>

bool DragCommand::VisitSettings ( SettingsVisitorBase< Const > & S )

Definition at line 63 of file DragCommand.cpp.

                                                               {
   S.OptionalN( bHasId         ).Define(     mId,          wxT("Id"),         11000, -100000, 1000000);
   S.OptionalY( bHasWinName    ).Define(     mWinName,     wxT("Window"),     wxString{"Timeline"});
   S.OptionalY( bHasFromX      ).Define(     mFromX,       wxT("FromX"),      200.0, 0.0, 1000000.0);
   S.OptionalY( bHasFromY      ).Define(     mFromY,       wxT("FromY"),      10.0,  0.0, 1000000.0);
   S.OptionalN( bHasToX        ).Define(     mToX,         wxT("ToX"),        400.0, 0.0, 1000000.0);
   S.OptionalN( bHasToY        ).Define(     mToY,         wxT("ToY"),        10.0,  0.0, 1000000.0);
   S.OptionalN( bHasRelativeTo ).DefineEnum( mRelativeTo,  wxT("RelativeTo"), kPanel, kCoordTypeStrings, nCoordTypes );
   return true;
};