Detailed Description

Function to handle text properties.

Each character in an M-text can have properties called text properties. Text properties store various kinds of information attached to parts of an M-text to provide application programs with a unified view of those information. As rich information can be stored in M-texts in the form of text properties, functions in application programs can be simple.

A text property consists of a key and values, where key is a symbol and values are anything that can be cast to (void *) . Unlike other types of properties, a text property can have multiple values. 'The text property whose key is K' may be shortened to 'K property'.

Typedef Documentation

typedef \fBMPlist\fP*(* \fBMTextPropSerializeFunc\fP)(void *val)

Type of serializer functions. This is the type of serializer functions. If the key of a symbol property is Mtext_prop_serializer, the value must be of this type.

SEE ALSO

mtext_serialize(), Mtext_prop_serializer

typedef void*(* \fBMTextPropDeserializeFunc\fP)(\fBMPlist\fP *plist)

Type of deserializer functions. This is the type of deserializer functions. If the key of a symbol property is Mtext_prop_deserializer, the value must be of this type.

SEE ALSO

mtext_deserialize(), Mtext_prop_deserializer

typedef struct \fBMTextProperty\fP \fBMTextProperty\fP

Type of text properties. The type MTextProperty is for a text property objects. Its internal structure is concealed from application programs.

Enumeration Type Documentation

enum \fBMTextPropertyControl\fP

Flag bits to control text property. The mtext_property() function accepts logical OR of these flag bits as an argument. They control the behaviour of the created text property as described in the documentation of each flag bit.

Enumerator:

MTEXTPROP_FRONT_STICKY

If this flag bit is on, an M-text inserted at the start position or at the middle of the text property inherits the text property.

MTEXTPROP_REAR_STICKY

If this flag bit is on, an M-text inserted at the end position or at the middle of the text property inherits the text property.

MTEXTPROP_VOLATILE_WEAK

If this flag bit is on, the text property is removed if a text in its region is modified.

MTEXTPROP_VOLATILE_STRONG

If this flag bit is on, the text property is removed if a text or the other text property in its region is modified.

MTEXTPROP_NO_MERGE

If this flag bit is on, the text property is not automatically merged with the others.

MTEXTPROP_CONTROL_MAX

Variable Documentation

\fBMSymbol\fP \fBMtext_prop_serializer\fP

Symbol for specifying serializer functions. To serialize a text property, the user must supply a serializer function for that text property. This is done by giving a symbol property whose key is Mtext_prop_serializer and value is a pointer to an appropriate serializer function.

SEE ALSO

mtext_serialize(), MTextPropSerializeFunc

\fBMSymbol\fP \fBMtext_prop_deserializer\fP

Symbol for specifying deserializer functions. To deserialize a text property, the user must supply a deserializer function for that text property. This is done by giving a symbol property whose key is Mtext_prop_deserializer and value is a pointer to an appropriate deserializer function.

SEE ALSO

mtext_deserialize(), MTextPropSerializeFunc

Author

Generated automatically by Doxygen for The m17n Library from the source code.

COPYRIGHT

Copyright (C) 2001 Information-technology Promotion Agency (IPA)

Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.