parse_markup


Description:


public bool parse_markup (string markup_text, int length, unichar accel_marker, out AttrList attr_list, out string text, out unichar accel_char) throws Error

Parses marked-up text (see markup format) to create a plain-text string and an attribute list.

If accel_marker is nonzero, the given character will mark the character following it as an accelerator. For example, accel_marker might be an ampersand or underscore. All characters marked as an accelerator will receive a LOW attribute, and the first character so marked will be returned in accel_char. Two accel_marker characters following each other produce a single literal accel_marker character.

To parse a stream of pango markup incrementally, use markup_parser_new.

If any error happens, none of the output arguments are touched except for error.

Parameters:

markup_text

markup to parse (see markup format)

length

length of markup_text, or -1 if nul-terminated

accel_marker

character that precedes an accelerator, or 0 for none

attr_list

address of return location for a AttrList, or null

text

address of return location for text with tags stripped, or null

accel_char

address of return location for accelerator char, or null

Returns:

false if error is set, otherwise true


Namespace: Pango
Package: pango