| ibusattribute.h | | ibusattribute.h | |
| | | | |
| skipping to change at line 141 | | skipping to change at line 141 | |
| * @start_index: Where attribute starts. | | * @start_index: Where attribute starts. | |
| * @end_index: Where attribute ends. | | * @end_index: Where attribute ends. | |
| * @returns: A newly allocated IBusAttribute. | | * @returns: A newly allocated IBusAttribute. | |
| * | | * | |
| * New an IBusAttribute. | | * New an IBusAttribute. | |
| */ | | */ | |
| IBusAttribute *ibus_attribute_new (guint type, | | IBusAttribute *ibus_attribute_new (guint type, | |
| guint value, | | guint value, | |
| guint start_inde
x, | | guint start_inde
x, | |
| guint end_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: | | * ibus_attr_underline_new: | |
| * @underline_type: Type of underline. | | * @underline_type: Type of underline. | |
| * @start_index: Where attribute starts. | | * @start_index: Where attribute starts. | |
| * @end_index: Where attribute ends. | | * @end_index: Where attribute ends. | |
|
| * @returns: A newly allocated IBusAttribute. | | * @returns: A newly allocated #IBusAttribute. | |
| * | | * | |
|
| * New an underline IBusAttribute. | | * New an underline #IBusAttribute. | |
| */ | | */ | |
| IBusAttribute *ibus_attr_underline_new (guint underline_
type, | | IBusAttribute *ibus_attr_underline_new (guint underline_
type, | |
| guint start_inde
x, | | guint start_inde
x, | |
| guint end_index)
; | | guint end_index)
; | |
| /** | | /** | |
| * ibus_attr_foreground_new: | | * ibus_attr_foreground_new: | |
| * @color: Color in RGB. | | * @color: Color in RGB. | |
| * @start_index: Where attribute starts. | | * @start_index: Where attribute starts. | |
| * @end_index: Where attribute ends. | | * @end_index: Where attribute ends. | |
|
| * @returns: A newly allocated IBusAttribute. | | * @returns: A newly allocated #IBusAttribute. | |
| * | | * | |
|
| * New an foreground IBusAttribute. | | * New an foreground #IBusAttribute. | |
| */ | | */ | |
| IBusAttribute *ibus_attr_foreground_new (guint color, | | IBusAttribute *ibus_attr_foreground_new (guint color, | |
| guint start_inde
x, | | guint start_inde
x, | |
| guint end_index)
; | | guint end_index)
; | |
| /** | | /** | |
| * ibus_attr_background_new: | | * ibus_attr_background_new: | |
| * @color: Color in RGB. | | * @color: Color in RGB. | |
| * @start_index: Where attribute starts. | | * @start_index: Where attribute starts. | |
| * @end_index: Where attribute ends. | | * @end_index: Where attribute ends. | |
|
| * @returns: A newly allocated IBusAttribute. | | * @returns: A newly allocated #IBusAttribute. | |
| * | | * | |
|
| * New an background IBusAttribute. | | * New an background #IBusAttribute. | |
| */ | | */ | |
| IBusAttribute *ibus_attr_background_new (guint color, | | IBusAttribute *ibus_attr_background_new (guint color, | |
| guint start_inde
x, | | guint start_inde
x, | |
| guint end_index)
; | | guint end_index)
; | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 7 change blocks. |
| 6 lines changed or deleted | | 45 lines changed or added | |
|
| ibusserializable.h | | ibusserializable.h | |
| | | | |
| skipping to change at line 90 | | skipping to change at line 90 | |
| * Attach a value to an IBusSerializable. | | * Attach a value to an IBusSerializable. | |
| * This macro is an convenient wrapper of ibus_serializable_set_qattachment
(). | | * This macro is an convenient wrapper of ibus_serializable_set_qattachment
(). | |
| */ | | */ | |
| #define ibus_serializable_set_attachment(o, k, v) \ | | #define ibus_serializable_set_attachment(o, k, v) \ | |
| ibus_serializable_set_qattachment (o, g_quark_from_string (k), v) | | ibus_serializable_set_qattachment (o, g_quark_from_string (k), v) | |
| | | | |
| /** | | /** | |
| * ibus_serializable_get_attachment: | | * ibus_serializable_get_attachment: | |
| * @o: An IBusSerializable. | | * @o: An IBusSerializable. | |
| * @k: String formatted key for indexing value. | | * @k: String formatted key for indexing value. | |
|
| * @v: Value to be attached. Should be also serializable. | | | |
| * | | * | |
| * Get a value from attachment of an IBusSerializable. | | * Get a value from attachment of an IBusSerializable. | |
| * This macro is an convenient wrapper of ibus_serializable_get_qattachment
(). | | * This macro is an convenient wrapper of ibus_serializable_get_qattachment
(). | |
| */ | | */ | |
|
| #define ibus_serializable_get_attachment(o, k, v) \ | | #define ibus_serializable_get_attachment(o, k) \ | |
| ibus_serializable_get_qattachment (o, g_quark_from_string (k)) | | ibus_serializable_get_qattachment (o, g_quark_from_string (k)) | |
| | | | |
| /** | | /** | |
| * ibus_serializable_remove_attachment: | | * ibus_serializable_remove_attachment: | |
| * @o: An IBusSerializable. | | * @o: An IBusSerializable. | |
| * @k: String formatted key for indexing value. | | * @k: String formatted key for indexing value. | |
| * | | * | |
| * Remove a value from attachment of an IBusSerializable. | | * Remove a value from attachment of an IBusSerializable. | |
| * This macro is an convenient wrapper of ibus_serializable_remove_qattachm
ent(). | | * This macro is an convenient wrapper of ibus_serializable_remove_qattachm
ent(). | |
| */ | | */ | |
| | | | |
| skipping to change at line 130 | | skipping to change at line 129 | |
| */ | | */ | |
| struct _IBusSerializable { | | struct _IBusSerializable { | |
| /*< private >*/ | | /*< private >*/ | |
| IBusObject parent; | | IBusObject parent; | |
| IBusSerializablePrivate *priv; | | IBusSerializablePrivate *priv; | |
| /* instance members */ | | /* instance members */ | |
| }; | | }; | |
| | | | |
| /** | | /** | |
| * IBusSerializableSerializeFunc: | | * IBusSerializableSerializeFunc: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @iter: An IBusMessageIter. | | * @builder: A #GVariantBuilder. | |
| * @returns: TRUE if succeed; FALSE otherwise. | | * @returns: %TRUE if succeed; %FALSE otherwise. | |
| * | | * | |
| * Prototype of serialize function. | | * Prototype of serialize function. | |
| * Serialize function convert an IBusSerializable to IBusMessageIter. | | * Serialize function convert an IBusSerializable to IBusMessageIter. | |
| * Returns a gboolean value which indicates whether the conversion is succe
ss. | | * Returns a gboolean value which indicates whether the conversion is succe
ss. | |
|
| * Return TRUE if succeed. | | * Return %TRUE if succeed. | |
| */ | | */ | |
|
| typedef gboolean (* IBusSerializableSerializeFunc) (IBusSerializable
*object, | | typedef gboolean (* IBusSerializableSerializeFunc) (IBusSerializable
*serializable, | |
| GVariantBuilder
*builder); | | GVariantBuilder
*builder); | |
| | | | |
| /** | | /** | |
| * IBusSerializableDeserializeFunc: | | * IBusSerializableDeserializeFunc: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @iter: An IBusMessageIter. | | * @variant: A #GVariant contains a tuple. | |
| * @returns: TRUE if succeed; FALSE otherwise. | | * @returns: The number of values in the variant(tuple) are consumed. | |
| * | | * | |
| * Prototype of deserialize function. | | * Prototype of deserialize function. | |
| * Deserialize function convert an IBusMessageIter to IBusSerializable. | | * Deserialize function convert an IBusMessageIter to IBusSerializable. | |
|
| * Returns a gboolean value which indicates whether the conversion is succe | | * Returns an integer value which indicates how many values in | |
| ss. | | * the variant(tuple) are consumed. | |
| */ | | */ | |
|
| typedef gint (* IBusSerializableDeserializeFunc) (IBusSerializable
*object, | | typedef gint (* IBusSerializableDeserializeFunc) (IBusSerializable
*serializable, | |
| GVariant
*variant); | | GVariant
*variant); | |
| | | | |
| /** | | /** | |
| * IBusSerializableCopyFunc: | | * IBusSerializableCopyFunc: | |
|
| * @dest: The destination IBusSerializable. | | * @dest: The destination #IBusSerializable. | |
| * @src: A source IBusMessageIter. | | * @src: A source #IBusMessageIter. | |
| * @returns: TRUE if succeed; FALSE otherwise. | | * @returns: %TRUE if succeed; %FALSE otherwise. | |
| * | | * | |
| * Prototype of copy function. | | * Prototype of copy function. | |
|
| * Copy function copy from source IBusSerializable to the destination one. | | * Copy function copy from source #IBusSerializable to the destination one. | |
| * Returns a gboolean value which indicates whether the copying is success. | | * Returns a gboolean value which indicates whether the copying is success. | |
| */ | | */ | |
| typedef gboolean (* IBusSerializableCopyFunc) (IBusSerializable
*dest, | | typedef gboolean (* IBusSerializableCopyFunc) (IBusSerializable
*dest, | |
| const IBusSerializ
able *src); | | const IBusSerializ
able *src); | |
| struct _IBusSerializableClass { | | struct _IBusSerializableClass { | |
| /*< private >*/ | | /*< private >*/ | |
| IBusObjectClass parent; | | IBusObjectClass parent; | |
| | | | |
| /* virtual table */ | | /* virtual table */ | |
| gboolean (* serialize) (IBusSerializable *object, | | gboolean (* serialize) (IBusSerializable *object, | |
| | | | |
| skipping to change at line 192 | | skipping to change at line 192 | |
| | | | |
| GType ibus_serializable_get_type (void); | | GType ibus_serializable_get_type (void); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_new: | | * ibus_serializable_new: | |
| * | | * | |
| * Creates a new instance of an #IBusSerializable. | | * Creates a new instance of an #IBusSerializable. | |
| * | | * | |
| * Returns: a new instance of #IBusSerializable. | | * Returns: a new instance of #IBusSerializable. | |
| */ | | */ | |
|
| IBusSerializable * ibus_serializable_new (void); | | IBusSerializable *ibus_serializable_new (void); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_set_qattachment: | | * ibus_serializable_set_qattachment: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @key: String formatted key for indexing value. | | * @key: String formatted key for indexing value. | |
|
| * @value: Value to be attached. Should be also serializable. | | * @value: Value to be attached or %NULL to remove any prevoius value. | |
| * @returns: TRUE if succeed; FALSE otherwise. | | | |
| * | | * | |
|
| * Attach a value to an IBusSerializable. The value should be serializable | | * Attach a value to an IBusSerializable. If the value is floating, | |
| as well. | | * the serializable will take the ownership. | |
| * Basic type such as integer, string are deemed to be serializable. | | | |
| * | | * | |
| * @see_also: ibus_serializable_set_attachment(). | | * @see_also: ibus_serializable_set_attachment(). | |
| */ | | */ | |
|
| gboolean ibus_serializable_set_qattachment (IBusSerializable
*object, | | void ibus_serializable_set_qattachment (IBusSerializable
*serializable, | |
| GQuark
key, | | GQuark
key, | |
|
| const GValue
*value); | | GVariant
*value); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_get_qattachment: | | * ibus_serializable_get_qattachment: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @key: String formatted key for indexing value. | | * @key: String formatted key for indexing value. | |
|
| * @returns: The attached value; or NULL if fail to retrieve the value. | | * @returns: The attached value; or %NULL if fail to retrieve the value. | |
| * | | * | |
|
| * Get a value from attachment of an IBusSerializable. | | * Get a value from attachment of an #IBusSerializable. | |
| * @see_also: ibus_serializable_set_attachment(). | | * @see_also: ibus_serializable_set_attachment(). | |
| */ | | */ | |
|
| const GValue *ibus_serializable_get_qattachment (IBusSerializable
*object, | | GVariant *ibus_serializable_get_qattachment (IBusSerializable
*serializable, | |
| GQuark
key); | | GQuark
key); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_remove_qattachment: | | * ibus_serializable_remove_qattachment: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @key: String formatted key for indexing value. | | * @key: String formatted key for indexing value. | |
| * | | * | |
|
| * Remove a value from attachment of an IBusSerializable. | | * Remove a value from attachment of an #IBusSerializable. | |
| * @see_also: ibus_serializable_remove_attachment(). | | * @see_also: ibus_serializable_remove_attachment(). | |
| */ | | */ | |
| void ibus_serializable_remove_qattachment | | void ibus_serializable_remove_qattachment | |
|
| (IBusSerializable
*object, | | (IBusSerializable
*serializable, | |
| GQuark
key); | | GQuark
key); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_copy: | | * ibus_serializable_copy: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @returns: A newly allocated clone object; or NULL if @object is not seri | | * @returns: A newly allocated clone object; or %NULL if @object is not ser | |
| alizable. | | ializable. | |
| * | | * | |
|
| * Clone an IBusSerializable. | | * Clone an #IBusSerializable. | |
| * The copy method should be implemented in extended class. | | * The copy method should be implemented in extended class. | |
| * | | * | |
| * @see_also: IBusSerializableCopyFunc(). | | * @see_also: IBusSerializableCopyFunc(). | |
| */ | | */ | |
|
| IBusSerializable *ibus_serializable_copy (IBusSerializable
*object); | | IBusSerializable *ibus_serializable_copy (IBusSerializable
*serializable); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_serialize: | | * ibus_serializable_serialize: | |
|
| * @object: An IBusSerializable. | | * @serializable: An #IBusSerializable. | |
| * @iter: An IBusMessageIter. | | * @returns: A #GVariant. | |
| * @returns: TRUE if succeed; FALSE otherwise. | | | |
| * | | * | |
|
| * Serialize an IBusSerializable to an IBusMessageIter. | | * Serialize an #IBusSerializable to a #GVariant. | |
| * The serialize method should be implemented in extended class. | | * The serialize method should be implemented in extended class. | |
| * | | * | |
| * @see_also: IBusSerializableCopyFunc(). | | * @see_also: IBusSerializableCopyFunc(). | |
| */ | | */ | |
|
| GVariant *ibus_serializable_serialize (IBusSerializable
*object); | | GVariant *ibus_serializable_serialize (IBusSerializable
*serializable); | |
| | | | |
| /** | | /** | |
| * ibus_serializable_deserialize: | | * ibus_serializable_deserialize: | |
|
| * @iter: An IBusMessageIter. | | * @variant: A #GVariant. | |
| * @returns: The deserialized IBusSerializable. | | * @returns: The deserialized #IBusSerializable. | |
| * | | * | |
|
| * Deserialize an IBusMessageIter to an IBusSerializable/ | | * Deserialize a #GVariant to an #IBusSerializable/ | |
| * The deserialize method should be implemented in extended class. | | * The deserialize method should be implemented in extended class. | |
| * | | * | |
| * @see_also: IBusSerializableCopyFunc(). | | * @see_also: IBusSerializableCopyFunc(). | |
| */ | | */ | |
| IBusSerializable *ibus_serializable_deserialize (GVariant
*variant); | | IBusSerializable *ibus_serializable_deserialize (GVariant
*variant); | |
| | | | |
| G_END_DECLS | | G_END_DECLS | |
| #endif | | #endif | |
| | | | |
End of changes. 31 change blocks. |
| 46 lines changed or deleted | | 42 lines changed or added | |
|