1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-27 06:07:59 +02:00
audacity/src/tracks/ui/CommonTrackControls.cpp

419 lines
12 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
CommonTrackControls.cpp
Paul Licameli split from TrackControls.cpp
**********************************************************************/
#include "CommonTrackControls.h"
#include "TrackButtonHandles.h"
#include "TrackSelectHandle.h"
#include "../../AColor.h"
#include "../../RefreshCode.h"
#include "../../Project.h"
#include "../../ProjectHistory.h"
#include "../../TrackArtist.h"
#include "../../TrackInfo.h"
#include "../../TrackPanelDrawingContext.h"
#include "../../TrackPanelMouseEvent.h"
#include "../../TrackUtilities.h"
#include <wx/textdlg.h>
#include "../../commands/CommandType.h"
#include "../../commands/CommandManager.h"
#include "../../ShuttleGui.h"
#include "../../Track.h"
#include "../../widgets/PopupMenuTable.h"
#include <wx/dc.h>
#include <wx/frame.h>
std::vector<UIHandlePtr> CommonTrackControls::HitTest
(const TrackPanelMouseState &st,
const AudacityProject *WXUNUSED(project))
{
// Hits are mutually exclusive, results single
const wxMouseState &state = st.state;
const wxRect &rect = st.rect;
UIHandlePtr result;
std::vector<UIHandlePtr> results;
auto sThis = shared_from_this();
if (NULL != (result = CloseButtonHandle::HitTest(
mCloseHandle, state, rect, this)))
results.push_back(result);
if (NULL != (result = MenuButtonHandle::HitTest(
mMenuHandle, state, rect, sThis)))
results.push_back(result);
if (NULL != (result = MinimizeButtonHandle::HitTest(
mMinimizeHandle, state, rect, this)))
results.push_back(result);
if (NULL != (result = SelectButtonHandle::HitTest(
mSelectButtonHandle, state, rect, this)))
results.push_back(result);
if (results.empty()) {
if (NULL != (result = TrackSelectHandle::HitAnywhere(
mSelectHandle, FindTrack())))
results.push_back(result);
}
return results;
}
enum
{
OnSetNameID = 2000,
OnMoveUpID,
OnMoveDownID,
OnMoveTopID,
OnMoveBottomID,
};
class TrackMenuTable : public PopupMenuTable
{
TrackMenuTable() : mpData(NULL) {}
DECLARE_POPUP_MENU(TrackMenuTable);
public:
static TrackMenuTable &Instance();
private:
void OnSetName(wxCommandEvent &);
void OnMoveTrack(wxCommandEvent &event);
void InitUserData(void *pUserData) override;
void InitMenu(Menu *pMenu) override;
void DestroyMenu() override
{
mpData = nullptr;
}
CommonTrackControls::InitMenuData *mpData;
};
TrackMenuTable &TrackMenuTable::Instance()
{
static TrackMenuTable instance;
return instance;
}
void TrackMenuTable::InitUserData(void *pUserData)
{
mpData = static_cast<CommonTrackControls::InitMenuData*>(pUserData);
}
void TrackMenuTable::InitMenu(Menu *pMenu)
{
Track *const pTrack = mpData->pTrack;
const auto &tracks = TrackList::Get( mpData->project );
pMenu->Enable(OnMoveUpID, tracks.CanMoveUp(pTrack));
pMenu->Enable(OnMoveDownID, tracks.CanMoveDown(pTrack));
pMenu->Enable(OnMoveTopID, tracks.CanMoveUp(pTrack));
pMenu->Enable(OnMoveBottomID, tracks.CanMoveDown(pTrack));
}
BEGIN_POPUP_MENU(TrackMenuTable)
POPUP_MENU_ITEM(OnSetNameID, XO("&Name..."), OnSetName)
POPUP_MENU_SEPARATOR()
POPUP_MENU_ITEM(
// It is not correct to use NormalizedKeyString::Display here --
// wxWidgets will apply its equivalent to the key names passed to menu
// functions.
OnMoveUpID,
XO("Move Track &Up").Join(
Verbatim(
CommandManager::Get( mpData->project ).
// using GET to compose menu item name for wxWidgets
GetKeyFromName(wxT("TrackMoveUp")).GET() ),
wxT("\t")
),
OnMoveTrack)
POPUP_MENU_ITEM(
OnMoveDownID,
XO("Move Track &Down").Join(
Verbatim(
CommandManager::Get( mpData->project ).
// using GET to compose menu item name for wxWidgets
GetKeyFromName(wxT("TrackMoveDown")).GET() ),
wxT("\t")
),
OnMoveTrack)
POPUP_MENU_ITEM(
OnMoveTopID,
XO("Move Track to &Top").Join(
Verbatim(
CommandManager::Get( mpData->project ).
// using GET to compose menu item name for wxWidgets
GetKeyFromName(wxT("TrackMoveTop")).GET() ),
wxT("\t")
),
OnMoveTrack)
POPUP_MENU_ITEM(
OnMoveBottomID,
XO("Move Track to &Bottom").Join(
Verbatim(
CommandManager::Get( mpData->project ).
// using GET to compose menu item name for wxWidgets
GetKeyFromName(wxT("TrackMoveBottom")).GET() ),
wxT("\t")
),
OnMoveTrack)
END_POPUP_MENU()
#define SET_TRACK_NAME_PLUGIN_SYMBOL ComponentInterfaceSymbol{ XO("Set Track Name") }
// An example of using an AudacityCommand simply to create a dialog.
// We can add additional functions later, if we want to make it
// available to scripting.
// However there is no reason to, as SetTrackStatus is already provided.
class SetTrackNameCommand : public AudacityCommand
{
public:
// ComponentInterface overrides
ComponentInterfaceSymbol GetSymbol() override
{return SET_TRACK_NAME_PLUGIN_SYMBOL;};
//TranslatableString GetDescription() override {return XO("Sets the track name.");};
//bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
//bool Apply(const CommandContext & context) override;
// Provide an override, if we want the help button.
// wxString ManualPage() override {return wxT("");};
public:
wxString mName;
};
void SetTrackNameCommand::PopulateOrExchange(ShuttleGui & S)
{
S.AddSpace(0, 5);
S.StartMultiColumn(2, wxALIGN_CENTER);
{
S.TieTextBox(XO("Name:"),mName,60);
}
S.EndMultiColumn();
}
void TrackMenuTable::OnSetName(wxCommandEvent &)
{
Track *const pTrack = mpData->pTrack;
if (pTrack)
{
AudacityProject *const proj = &mpData->project;
const wxString oldName = pTrack->GetName();
SetTrackNameCommand Command;
Command.mName = oldName;
// Bug 1837 : We need an OK/Cancel result if we are to enter a blank string.
bool bResult = Command.PromptUser( &GetProjectFrame( *proj ) );
if (bResult)
{
wxString newName = Command.mName;
for (auto channel : TrackList::Channels(pTrack))
channel->SetName(newName);
ProjectHistory::Get( *proj )
.PushState(
XO("Renamed '%s' to '%s'").Format( oldName, newName ),
XO("Name Change"));
mpData->result = RefreshCode::RefreshAll;
}
}
}
void TrackMenuTable::OnMoveTrack(wxCommandEvent &event)
{
AudacityProject *const project = &mpData->project;
TrackUtilities::MoveChoice choice;
switch (event.GetId()) {
default:
wxASSERT(false);
case OnMoveUpID:
choice = TrackUtilities::OnMoveUpID; break;
case OnMoveDownID:
choice = TrackUtilities::OnMoveDownID; break;
case OnMoveTopID:
choice = TrackUtilities::OnMoveTopID; break;
case OnMoveBottomID:
choice = TrackUtilities::OnMoveBottomID; break;
}
TrackUtilities::DoMoveTrack(*project, mpData->pTrack, choice);
// MoveTrack already refreshed TrackPanel, which means repaint will happen.
// This is a harmless redundancy:
mpData->result = RefreshCode::RefreshAll;
}
unsigned CommonTrackControls::DoContextMenu(
const wxRect &rect, wxWindow *pParent, wxPoint *, AudacityProject *pProject)
{
using namespace RefreshCode;
wxRect buttonRect;
TrackInfo::GetTitleBarRect(rect, buttonRect);
auto track = FindTrack();
if (!track)
return RefreshNone;
InitMenuData data{ *pProject, track.get(), pParent, RefreshNone };
const auto pTable = &TrackMenuTable::Instance();
auto pMenu = PopupMenuTable::BuildMenu(pParent, pTable, &data);
PopupMenuTable *const pExtension = GetMenuExtension(track.get());
if (pExtension)
pMenu->Extend(pExtension);
pParent->PopupMenu
(pMenu.get(), buttonRect.x + 1, buttonRect.y + buttonRect.height + 1);
return data.result;
}
// Some old cut-and-paste legacy from TrackPanel.cpp here:
#if 0
void TrackInfo::DrawBordersWithin
( wxDC* dc, const wxRect & rect, const Track &track ) const
{
AColor::Dark(dc, false); // same color as border of toolbars (ToolBar::OnPaint())
// below close box and title bar
wxRect buttonRect;
GetTitleBarRect( rect, buttonRect );
AColor::Line
(*dc, rect.x, buttonRect.y + buttonRect.height,
rect.width - 1, buttonRect.y + buttonRect.height);
// between close box and title bar
AColor::Line
(*dc, buttonRect.x, buttonRect.y,
buttonRect.x, buttonRect.y + buttonRect.height - 1);
GetMuteSoloRect( rect, buttonRect, false, true, &track );
bool bHasMuteSolo = dynamic_cast<const PlayableTrack*>( &track ) != NULL;
if( bHasMuteSolo && !TrackInfo::HideTopItem( rect, buttonRect ) )
{
// above mute/solo
AColor::Line
(*dc, rect.x, buttonRect.y,
rect.width - 1, buttonRect.y);
// between mute/solo
// Draw this little line; if there is no solo, wide mute button will
// overpaint it later:
AColor::Line
(*dc, buttonRect.x + buttonRect.width, buttonRect.y,
buttonRect.x + buttonRect.width, buttonRect.y + buttonRect.height - 1);
// below mute/solo
AColor::Line
(*dc, rect.x, buttonRect.y + buttonRect.height,
rect.width - 1, buttonRect.y + buttonRect.height);
}
// left of and above minimize button
wxRect minimizeRect;
this->GetMinimizeRect(rect, minimizeRect);
AColor::Line
(*dc, minimizeRect.x - 1, minimizeRect.y,
minimizeRect.x - 1, minimizeRect.y + minimizeRect.height - 1);
AColor::Line
(*dc, minimizeRect.x, minimizeRect.y - 1,
minimizeRect.x + minimizeRect.width - 1, minimizeRect.y - 1);
}
#endif
void CommonTrackControls::Draw(
TrackPanelDrawingContext &context,
const wxRect &rect_, unsigned iPass )
{
if ( iPass == TrackArtist::PassMargins ) {
// fill in label
auto dc = &context.dc;
const auto pTrack = FindTrack();
AColor::MediumTrackInfo( dc, pTrack && pTrack->GetSelected() );
dc->DrawRectangle( rect_ );
}
if ( iPass == TrackArtist::PassControls ) {
// Given rectangle excludes left and right margins, and encompasses a
// channel group of tracks, plus the resizer area below
auto pTrack = FindTrack();
// First counteract DrawingArea() correction
wxRect rect{ rect_.x, rect_.y, rect_.width - 1, rect_.height };
// Vaughan, 2010-08-24: No longer doing this.
// Draw sync-lock tiles in ruler area.
//if (t->IsSyncLockSelected()) {
// wxRect tileFill = rect;
// tileFill.x = mViewInfo->GetVRulerOffset();
// tileFill.width = mViewInfo->GetVRulerWidth();
// TrackArt::DrawSyncLockTiles(dc, tileFill);
//}
if (pTrack)
// Draw things within the track control panel
TrackInfo::DrawItems( context, rect, *pTrack );
//mTrackInfo.DrawBordersWithin( dc, rect, *t );
}
// Some old cut-and-paste legacy from TrackPanel.cpp here:
#undef USE_BEVELS
#ifdef USE_BEVELS
// This branch is not now used
// PRL: todo: banish magic numbers.
// PRL: vrul was the x coordinate of left edge of the vertical ruler.
// PRL: bHasMuteSolo was true iff the track was WaveTrack.
if( bHasMuteSolo )
{
int ylast = rect.height-20;
int ybutton = wxMin(32,ylast-17);
int ybuttonEnd = 67;
fill=wxRect( rect.x+1, rect.y+17, vrul-6, ybutton);
AColor::BevelTrackInfo( *dc, true, fill );
if( ybuttonEnd < ylast ){
fill=wxRect( rect.x+1, rect.y+ybuttonEnd, fill.width, ylast - ybuttonEnd);
AColor::BevelTrackInfo( *dc, true, fill );
}
}
else
{
fill=wxRect( rect.x+1, rect.y+17, vrul-6, rect.height-37);
AColor::BevelTrackInfo( *dc, true, fill );
}
#endif
}
wxRect CommonTrackControls::DrawingArea(
TrackPanelDrawingContext &,
const wxRect &rect, const wxRect &, unsigned iPass )
{
if ( iPass == TrackArtist::PassControls )
// Some bevels spill out right
return { rect.x, rect.y, rect.width + 1, rect.height };
else
return rect;
}