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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* IBus - The Input Bus
* Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2013 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
#ifndef __IBUS_ATTRIBUTE_H_
#define __IBUS_ATTRIBUTE_H_
/**
* SECTION: ibusattribute
* @short_description: Attributes of IBusText.
* @see_also: #IBusText
* @stability: Stable
*
* An IBusAttribute represents an attribute that associate to IBusText.
* It decorates preedit buffer and auxiliary text with underline, foreground
* and background colors.
*/
#include "ibusserializable.h"
G_BEGIN_DECLS
/*
* Type macros.
*/
/* define IBusAttribute macros */
#define IBUS_TYPE_ATTRIBUTE \
(ibus_attribute_get_type ())
#define IBUS_ATTRIBUTE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_ATTRIBUTE, IBusAttribute))
#define IBUS_ATTRIBUTE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_ATTRIBUTE, IBusAttributeClass))
#define IBUS_IS_ATTRIBUTE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_ATTRIBUTE))
#define IBUS_IS_ATTRIBUTE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_ATTRIBUTE))
#define IBUS_ATTRIBUTE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_ATTRIBUTE, IBusAttributeClass))
/**
* IBusAttrType:
* @IBUS_ATTR_TYPE_UNDERLINE: Decorate with underline.
* @IBUS_ATTR_TYPE_FOREGROUND: Foreground color.
* @IBUS_ATTR_TYPE_BACKGROUND: Background color.
*
* Type enumeration of IBusText attribute.
*/
typedef enum {
IBUS_ATTR_TYPE_UNDERLINE = 1,
IBUS_ATTR_TYPE_FOREGROUND = 2,
IBUS_ATTR_TYPE_BACKGROUND = 3,
} IBusAttrType;
/**
* IBusAttrUnderline:
* @IBUS_ATTR_UNDERLINE_NONE: No underline.
* @IBUS_ATTR_UNDERLINE_SINGLE: Single underline.
* @IBUS_ATTR_UNDERLINE_DOUBLE: Double underline.
* @IBUS_ATTR_UNDERLINE_LOW: Low underline ? %FIXME
* @IBUS_ATTR_UNDERLINE_ERROR: Error underline
*
* Type of IBusText attribute.
*/
typedef enum {
IBUS_ATTR_UNDERLINE_NONE = 0,
IBUS_ATTR_UNDERLINE_SINGLE = 1,
IBUS_ATTR_UNDERLINE_DOUBLE = 2,
IBUS_ATTR_UNDERLINE_LOW = 3,
IBUS_ATTR_UNDERLINE_ERROR = 4,
} IBusAttrUnderline;
typedef struct _IBusAttribute IBusAttribute;
typedef struct _IBusAttributeClass IBusAttributeClass;
/**
* IBusAttribute:
* @type: IBusAttributeType
* @value: Value for the type.
* @start_index: The starting index, inclusive.
* @end_index: The ending index, exclusive.
*
* Signify the type, value and scope of the attribute.
* The scope starts from @start_index till the @end_index-1.
*/
struct _IBusAttribute {
IBusSerializable parent;
/*< public >*/
guint type;
guint value;
guint start_index;
guint end_index;
};
struct _IBusAttributeClass {
IBusSerializableClass parent;
};
/**
* ibus_attribute_get_type:
* @returns: GType of IBusAttribute.
*
* Returns GType of IBusAttribute.
*/
GType ibus_attribute_get_type ();
/**
* ibus_attribute_new:
* @type: Type of the attribute.
* @value: Value of the attribute.
* @start_index: Where attribute starts.
* @end_index: Where attribute ends.
* @returns: (transfer none): A newly allocated IBusAttribute.
*
* New an IBusAttribute.
*/
IBusAttribute *ibus_attribute_new (guint type,
guint value,
guint start_index,
guint end_index);
/**
* ibus_attribute_get_attr_type:
* @returns: An enum of #IBusAttrType.
*
* Returns an enum of #IBusAttrType.
*/
guint ibus_attribute_get_attr_type
(IBusAttribute *attr);
/**
* ibus_attribute_get_value:
* @returns: An unsigned int value relative with #IBusAttrType.
*
* Returns an unsigned int value relative with #IBusAttrType.
* If the type is %IBUS_ATTR_TYPE_UNDERLINE, the return value is
* #IBusAttrUnderline. If the type is %IBUS_ATTR_TYPE_FOREGROUND,
* the return value is the color RGB.
*/
guint ibus_attribute_get_value (IBusAttribute *attr);
/**
* ibus_attribute_get_start_index:
* @returns: A start unsigned index
*
* Returns a start unsigned index
*/
guint ibus_attribute_get_start_index
(IBusAttribute *attr);
/**
* ibus_attribute_get_end_index:
* @returns: A end unsigned index
*
* Returns a end unsigned index
*/
guint ibus_attribute_get_end_index
(IBusAttribute *attr);
/**
* ibus_attr_underline_new:
* @underline_type: Type of underline.
* @start_index: Where attribute starts.
* @end_index: Where attribute ends.
* @returns: (transfer none): A newly allocated #IBusAttribute.
*
* New an underline #IBusAttribute.
*/
IBusAttribute *ibus_attr_underline_new (guint underline_type,
guint start_index,
guint end_index);
/**
* ibus_attr_foreground_new:
* @color: Color in RGB.
* @start_index: Where attribute starts.
* @end_index: Where attribute ends.
* @returns: (transfer none): A newly allocated #IBusAttribute.
*
* New an foreground #IBusAttribute.
*/
IBusAttribute *ibus_attr_foreground_new (guint color,
guint start_index,
guint end_index);
/**
* ibus_attr_background_new:
* @color: Color in RGB.
* @start_index: Where attribute starts.
* @end_index: Where attribute ends.
* @returns: (transfer none): A newly allocated #IBusAttribute.
*
* New an background #IBusAttribute.
*/
IBusAttribute *ibus_attr_background_new (guint color,
guint start_index,
guint end_index);
G_END_DECLS
#endif
|
