Jamoma API  0.6.0.a19
Max/source/j.ui/TTUiInfo.h
Go to the documentation of this file.
1 /** @file
2  *
3  * @ingroup maxLibrary
4  *
5  * @brief A base class for j.ui info
6  *
7  * @details
8  *
9  * @authors Théo de la Hogue
10  *
11  * @copyright © 2013, Théo de la Hogue @n
12  * This code is licensed under the terms of the "New BSD License" @n
13  * http://creativecommons.org/licenses/BSD/
14  */
15 
16 #ifndef __TT_UI_INFO_H__
17 #define __TT_UI_INFO_H__
18 
20 #include "j.ui.h"
21 
22 /** A base class for j.ui info
23  */
24 class TTUiInfo : public TTObjectBase
25 {
27 
28  TTValue mSize; ///< ATTRIBUTE : the size of the j.ui
29  TTBoolean mFreeze; ///< ATTRIBUTE : freeze all j.remote
30  TTSymbol mHighlight; ///< ATTRIBUTE : highlight the j.ui using a template color : none, red, orange, yellow, chartreuseGreen, green, springGreen, cyan, azure, blue, violet, magenta, rose, black, white, jamoma)
31 
32  t_ui* mObject; ///< cache the j.ui object
33 
34 public:
35 
36  /** Attribute accessor.
37  @param newValue a new horizontal and a vertical size value
38  @return TTErr kTTErrNone
39  */
40  TTErr setSize(const TTValue& newValue);
41 
42  /** Attribute accessor.
43  @param value current horizontal and a vertical size value
44  @return TTErr kTTErrNone
45  */
46  TTErr getSize(TTValue& value);
47 
48  /** Attribute accessor.
49  @param newValue a new freeze state
50  @return TTErr kTTErrNone
51  */
52  TTErr setFreeze(const TTValue& newValue);
53 
54  /** Set highlight color
55  @param newValue a new highlight color
56  @return TTErr kTTErrNone
57  */
58  TTErr setHighlight(const TTValue& inputValue);
59 
60  /** Open the ui panel
61  @return TTErr kTTErrNone
62  */
63  TTErr Panel();
64 };
65 
66 typedef TTUiInfo* TTUiInfoPtr;
67 
68 
69 #endif // __TT_UI_INFO_H__
bool TTBoolean
Boolean flag, same as Boolean on the Mac.
Definition: TTBase.h:167
Base class for all first-class Jamoma objects.
Definition: TTObjectBase.h:109
#define TTCLASS_SETUP(className)
TODO Doxygen: need more comments here.
Definition: TTFoundation.h:54
TTErr getSize(TTValue &value)
Attribute accessor.
The TTSymbol class is used to represent a string and efficiently pass and compare that string...
Definition: TTSymbol.h:26
A base class for j.ui info.
TTErr setSize(const TTValue &newValue)
Attribute accessor.
TTErr setHighlight(const TTValue &inputValue)
Set highlight color.
TTErr setFreeze(const TTValue &newValue)
Attribute accessor.
TTErr
Jamoma Error Codes Enumeration of error codes that might be returned by any of the TTBlue functions a...
Definition: TTBase.h:342
Wraps Jamoma Core classes as objects for Max/MSP.
TTErr Panel()
Open the ui panel.
[doxygenAppendixC_copyExample]
Definition: TTValue.h:34
j.ui : Provide standard user interface component for modules