Audacity  3.0.3
ComponentInterface.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  ComponentInterface.h
6 
7  Leland Lucius
8 
9  Copyright (c) 2014, Audacity Team
10  All rights reserved.
11 
12  Redistribution and use in source and binary forms, with or without
13  modification, are permitted provided that the following conditions
14  are met:
15 
16  1. Redistributions of source code must retain the above copyright
17  notice, this list of conditions and the following disclaimer.
18 
19  2. Redistributions in binary form must reproduce the above copyright
20  notice, this list of conditions and the following disclaimer in the
21  documentation and/or other materials provided with the distribution.
22 
23  3. Neither the name of the copyright holder nor the names of its
24  contributors may be used to endorse or promote products derived from
25  this software without specific prior written permission.
26 
27  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
30  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
31  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
34  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  POSSIBILITY OF SUCH DAMAGE.
39 
40 **********************************************************************/
41 
42 #ifndef __AUDACITY_COMPONENT_INTERFACE_H__
43 #define __AUDACITY_COMPONENT_INTERFACE_H__
44 
45 #include "Identifier.h"
46 #include "Internat.h"
47 #include <wx/string.h> // member variables
48 
51 
52 class ShuttleParams;
53 
54 /**************************************************************************/
61 class COMPONENTS_API ComponentInterface /* not final */
62 {
63 public:
65 
66  // These should return an untranslated value
67  virtual PluginPath GetPath() = 0;
68 
69  // The internal string persists in configuration files
70  // So config compatibility will break if it is changed across Audacity versions
72 
73  virtual VendorSymbol GetVendor() = 0;
74 
75  virtual wxString GetVersion() = 0;
76 
77  // This returns a translated string
78  // Any verb should be present tense indicative, not imperative
80 
81  // non-virtual convenience function
82  TranslatableString GetName();
83 
84  // Parameters, if defined. false means no defined parameters.
85  virtual bool DefineParams( ShuttleParams & WXUNUSED(S) ){ return false;};
86 };
87 
88 #endif // __AUDACITY_IDENTINTERFACE_H__
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
ComponentInterface::GetSymbol
virtual ComponentInterfaceSymbol GetSymbol()=0
PluginPath
wxString PluginPath
type alias for identifying a Plugin supplied by a module, each module defining its own interpretation...
Definition: Identifier.h:214
ShuttleParams
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:62
ComponentInterfaceSymbol::ComponentInterfaceSymbol
ComponentInterfaceSymbol()=default
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
ComponentInterface::GetVendor
virtual VendorSymbol GetVendor()=0
ComponentInterface::GetPath
virtual PluginPath GetPath()=0
Identifier.h
ComponentInterface::GetDescription
virtual TranslatableString GetDescription()=0
Internat.h
ComponentInterface::~ComponentInterface
virtual ~ComponentInterface()
ComponentInterface
ComponentInterface provides name / vendor / version functions to identify plugins....
Definition: ComponentInterface.h:62
ComponentInterface::GetVersion
virtual wxString GetVersion()=0
ComponentInterface::DefineParams
virtual bool DefineParams(ShuttleParams &WXUNUSED(S))
Definition: ComponentInterface.h:85