HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OPUI_GraphBadge.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: OPUI_GraphBadge.h (User Interface Library, C++)
7  *
8  * COMMENTS:
9  * A class to describe a node badge.
10  *
11  */
12 
13 #ifndef __OPUI_GraphBadge__
14 #define __OPUI_GraphBadge__
15 
16 #include "OPUI_API.h"
17 #include <UT/UT_Array.h>
18 #include <UT/UT_Color.h>
19 #include <UT/UT_StringHolder.h>
20 
22 class OPUI_GraphBadge;
23 class OP_Context;
24 
30 };
31 
35 };
36 
37 typedef bool (*OPUI_GraphBadgeTest)(const OPUI_GraphProxyDescriptor &desc,
38  OPUI_GraphBadgeVisibility visibility,
39  OP_Context &context,
40  UT_StringHolder &icon,
41  UT_Color &clr);
43 
45 {
46 public:
47  OPUI_GraphBadge(const UT_StringHolder &pref,
48  const UT_StringHolder &category,
49  const UT_StringHolder &description,
50  const UT_StringHolder &icon,
53  OPUI_GraphBadgeThreading threading);
54  ~OPUI_GraphBadge();
55 
57  { return myPreferenceName; }
59  { return myPreferenceCategory; }
61  { return myDescription; }
62  const UT_StringHolder &getIcon() const
63  { return myIcon; }
65  { return myDefaultVisibility; }
67  { return myBadgeTest; }
68  bool getThreadSafe() const
69  { return myThreadSafe; }
70 
72  { return myVisibility; }
74  { myVisibility = vis; }
75 
76  static void addBadges(OPUI_GraphBadgeArray &add_badges);
77 
92 
96 
99 
100 private:
101  UT_StringHolder myPreferenceName;
102  UT_StringHolder myPreferenceCategory;
103  UT_StringHolder myDescription;
104  UT_StringHolder myIcon;
105  OPUI_GraphBadgeVisibility myDefaultVisibility;
106  OPUI_GraphBadgeVisibility myVisibility;
107  OPUI_GraphBadgeTest myBadgeTest;
108  bool myThreadSafe;
109 };
110 
111 #endif
112 
static const UT_StringHolder theCommentPref
OPUI_GraphBadgeVisibility getVisibility() const
bool getThreadSafe() const
cvex test(vector P=0;int unbound=3;export float s=0;export vector Cf=0;)
Definition: test.vfl:11
static const UT_StringHolder theParametersBadgeCategory
static const UT_StringHolder theLopDebugPref
#define OPUI_API
Definition: OPUI_API.h:10
static const UT_StringHolder theKinematicsPref
static const UT_StringHolder theHDALockedPref
static const UT_StringHolder theConstraintsPref
const UT_StringHolder & getPreferenceName() const
static const UT_StringHolder theNodeHasDataPref
OPUI_GraphBadgeVisibility getDefaultVisibility() const
const UT_StringHolder & getDescription() const
UT_Array< OPUI_GraphBadge > OPUI_GraphBadgeArray
static const UT_StringHolder theNotCompilablePref
static const UT_StringHolder theErrorPref
static const UT_StringHolder theHasTakeDataPref
static const UT_StringHolder theWorkItemFilterPref
OPUI_GraphBadgeTest getBadgeTest() const
void setVisibility(OPUI_GraphBadgeVisibility vis)
static const UT_StringHolder theMainBadgeCategory
OPUI_GraphBadgeVisibility
const UT_StringHolder & getIcon() const
static const UT_StringHolder theNodeUnloadPref
static const UT_StringHolder theNeedsCookPref
static const UT_StringHolder theTimeDepPref
const UT_StringHolder & getPreferenceCategory() const
bool(* OPUI_GraphBadgeTest)(const OPUI_GraphProxyDescriptor &desc, OPUI_GraphBadgeVisibility visibility, OP_Context &context, UT_StringHolder &icon, UT_Color &clr)
OPUI_GraphBadgeThreading
static const UT_StringHolder theHDAUnlockedPref
static const UT_StringHolder theVexCachePref
static const UT_StringHolder theWarningPref
static const UT_StringHolder theNodeLockedPref