1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-07-14 15:48:21 +02:00
audacity/src/widgets/OverlayPanel.h
James Crook 1c988b4e3a Automation: AudacityCommand
This is a squash of 50 commits.

This merges the capabilities of BatchCommands and Effects using a new
AudacityCommand class.  AudacityCommand provides one function to specify the
parameters, and then we leverage that one function in automation, whether by chains,
mod-script-pipe or (future) Nyquist.

- Now have AudacityCommand which is using the same mechanism as Effect
- Has configurable parameters
- Has data-entry GUI (built using shuttle GUI)
- Registers with PluginManager.
- Menu commands now provided in chains, and to python batch.
   - Tested with Zoom Toggle.

- ShuttleParams now can set, get, set defaults, validate and specify
the parameters.
- Bugfix: Don't overwrite values with defaults first time out.
- Add DefineParams function for all built-in effects.
- Extend CommandContext to carry output channels for results.

We abuse EffectsManager.  It handles both Effects and
AudacityCommands now.  In time an Effect should become a special case of
AudacityCommand and we'll split and rename the EffectManager class.

- Don't use 'default' as a parameter name.
- Massive renaming for CommandDefinitionInterface
- EffectIdentInterface becomes EffectDefinitionInterface
- EffectAutomationParameters becomes CommandAutomationParameters
- PluginType is now a bit field.

This way we can search for related types at the same time.

- Most old batch commands made into AudacityCommands.
The ones that weren't are for a reason.  They are used by mod-script-pipe
to carry commands and responses across from a non-GUI thread to the GUI
thread.

- Major tidy up of ScreenshotCommand
- Reworking of SelectCommand
- GetPreferenceCommand and SetPreferenceCommand
- GetTrackInfo and SetTrackInfo
- GetInfoCommand
- Help, Open, Save, Import and Export commands.
- Removed obsolete commands ExecMenu, GetProjectInfo and SetProjectInfo
  which are now better handled by other commands.

- JSONify "GetInfo: Commands" output, i.e. commas in the right places.

- General work on better Doxygen.
    - Lyrics -> LyricsPanel
    - Meter -> MeterPanel
- Updated Linux makefile.
- Scripting commands added into Extra menu.
- Distinct names for previously duplicated find-clipping parameters.
- Fixed longstanding error with erroneous status field number which
  previously caused an ASSERT in debug.
- Sensible formatting of numbers in Chains, 0.1 not 0.1000000000137
2018-02-24 14:20:22 -05:00

52 lines
1.5 KiB
C++

//
// OverlayPanel.h
// Audacity
//
// Created by Paul Licameli on 5/1/16.
//
//
#ifndef __AUDACITY_OVERLAY_PANEL__
#define __AUDACITY_OVERLAY_PANEL__
#include <vector>
#include "BackedPanel.h"
class Overlay;
class AUDACITY_DLL_API OverlayPanel /* not final */ : public BackedPanel {
public:
OverlayPanel(wxWindow * parent, wxWindowID id,
const wxPoint & pos,
const wxSize & size,
// default as for wxPanel:
long style = wxTAB_TRAVERSAL | wxNO_BORDER);
// Registers and unregisters overlay objects.
// The sequence in which they were registered is the sequence in
// which they are painted.
// OverlayPanel is not responsible for their memory management.
void AddOverlay(Overlay *pOverlay);
// Returns true if the overlay was found
bool RemoveOverlay(Overlay *pOverlay);
void ClearOverlays();
// Erases and redraws to the client area the overlays that have
// been previously added with AddOverlay(). If "repaint_all" is
// true, all overlays will be erased and re-drawn. Otherwise, only
// the ones that are out-of-date, as well as the intersecting ones,
// will be erased and re-drawn.
// pDC can be null, in which case, DrawOverlays() will create a
// wxClientDC internally when necessary.
void DrawOverlays(bool repaint_all, wxDC *pDC = nullptr);
private:
std::vector<Overlay*> mOverlays;
DECLARE_EVENT_TABLE()
friend class GetInfoCommand;
};
#endif