Cortex  10.0.0-a4
ValidatedStringParameter.h
1 //
3 // Copyright (c) 2007-2010, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IE_CORE_VALIDATEDSTRINGPARAMETER_H
36 #define IE_CORE_VALIDATEDSTRINGPARAMETER_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/SimpleTypedParameter.h"
40 
41 namespace IECore
42 {
43 
46 class IECORE_API ValidatedStringParameter : public StringParameter
47 {
48  public :
49 
50  IE_CORE_DECLARERUNTIMETYPED( ValidatedStringParameter, StringParameter );
51 
52  ValidatedStringParameter( const std::string &name, const std::string &description,
53  const std::string &regex, const std::string &regexDescription = "", const std::string &defaultValue = "", bool allowEmptyString = true,
54  const StringParameter::PresetsContainer &presets = StringParameter::PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData = nullptr );
55 
56  const std::string &regex() const;
57  const std::string &regexDescription() const;
58  bool allowEmptyString() const;
59 
62  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
63 
64  private :
65 
66  std::string m_regex;
67  std::string m_regexDescription;
68  bool m_allowEmptyString;
69 
70 };
71 
72 IE_CORE_DECLAREPTR( ValidatedStringParameter )
73 
74 } // namespace IECore
75 
76 #endif // IE_CORE_VALIDATEDSTRINGPARAMETER_H
Definition: ValidatedStringParameter.h:46
Definition: TypedParameter.h:48
Definition: Object.h:104
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43