1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/** \file
* \brief Attributes Environment Management
*
* See Copyright Notice in "iup.h"
*/
#ifndef __IUP_ATTRIB_H
#define __IUP_ATTRIB_H
#ifdef __cplusplus
extern "C" {
#endif
/** \defgroup attrib Attribute Environment
* \par
* When attributes are not stored at the control
* they are stored in a hash table (see \ref table).
* \par
* As a general rule use:
* - IupGetAttribute, IupSetAttribute, ... : when care about control implementation, hash table, inheritance and default value
* - iupAttribGetStr,Int,Float: when care about inheritance, hash table and default value
* - iupAttribGet,... : ONLY access the hash table
* These different functions have very different performances and results. So use them wiselly.
* \par
* See \ref iup_attrib.h
* \ingroup cpi */
/** Returns true if the attribute name if in the internal format "_IUP...".
* \ingroup attrib */
#define iupATTRIB_ISINTERNAL(_name) ((_name[0] == '_' && _name[1] == 'I' && _name[2] == 'U' && _name[3] == 'P')? 1: 0)
/** Returns true if the attribute name is a known pointer.
* \ingroup attrib */
int iupAttribIsPointer(Ihandle* ih, const char *name);
/** Sets the attribute only in the hash table as a pointer.
* It ignores children.
* \ingroup attrib */
void iupAttribSetStr(Ihandle* ih, const char* name, const char* value);
/** Sets the attribute only in the hash table as a string.
* The string is internally duplicated.
* It ignores children.
* \ingroup attrib */
void iupAttribStoreStr(Ihandle* ih, const char* name, const char* value);
/** Sets the attribute only in the hash table as a string.
* The string is internally duplicated. Use same format as sprintf.
* It ignores children.
* \ingroup attrib */
void iupAttribSetStrf(Ihandle *ih, const char* name, const char* format, ...);
/** Sets an integer attribute only in the hash table.
* It will be stored as a string.
* It ignores children.
* \ingroup attrib */
void iupAttribSetInt(Ihandle *ih, const char* name, int num);
/** Sets an floating point attribute only in the hash table.
* It will be stored as a string.
* It ignores children.
* \ingroup attrib */
void iupAttribSetFloat(Ihandle *ih, const char* name, float num);
/** Returns the attribute from the hash table only.
* \ingroup attrib */
char* iupAttribGet(Ihandle* ih, const char* name);
/** Returns the attribute from the hash table only,
* but if not defined then checks in its parent tree.
* \ingroup attrib */
char* iupAttribGetInherit(Ihandle* ih, const char* name);
/** Returns the attribute from the hash table of a native parent.
* Don't check for default values. Don't check at the element.
* Used for BGCOLOR and BACKGROUND attributes.
* \ingroup attrib */
char* iupAttribGetInheritNativeParent(Ihandle* ih, const char* name);
/** Returns the attribute from the hash table as a string,
* but if not defined then checks in its parent tree if allowed by the control implementation,
* if still not defined then returns the registered default value if any.
* \ingroup attrib */
char* iupAttribGetStr(Ihandle* ih, const char* name);
/** Same as \ref iupAttribGetStr but returns an integer number.
* Checks also for boolean values.
* \ingroup attrib */
int iupAttribGetInt(Ihandle* ih, const char* name);
/** Same as \ref iupAttribGetStr but checks for boolean values.
* Use \ref iupStrBoolean.
* \ingroup attrib */
int iupAttribGetBoolean(Ihandle* ih, const char* name);
/** Same as \ref iupAttribGetStr but returns an floating point number.
* \ingroup attrib */
float iupAttribGetFloat(Ihandle* ih, const char* name);
/** Set an internal name to a handle.
* \ingroup attrib */
void iupAttribSetHandleName(Ihandle *ih);
/** Returns the internal name if set.
* \ingroup attrib */
char* iupAttribGetHandleName(Ihandle *ih);
/* For all attributes in the evironment, call the class SetAttribute only.
* Called only after the element is mapped, but before the children are mapped. */
void iupAttribUpdate(Ihandle* ih);
/* For all registered inherited attributes, checks the parent tree and
* call the class SetAttribute if the attribute is defined.
* Called only after the element is mapped, but before the children are mapped. */
void iupAttribUpdateFromParent(Ihandle* ih);
/* For all attributes in the evironment, call the class SetAttribute only for the children.
* Called only after the element is mapped, and after the children are mapped. */
void iupAttribUpdateChildren(Ihandle* ih);
/* Other functions declared in <iup.h> and implemented here.
IupGetAllAttributes
IupGetAttributes
IupSetAttributes
IupSetAttribute
IupStoreAttribute
IupGetAttribute
IupGetFloat
IupGetInt
IupGetInt2
IupSetfAttribute
IupSetAttributeHandle
IupGetAttributeHandle
*/
#ifdef __cplusplus
}
#endif
#endif
|
