Gtk.BuildableParseContext¶

record (struct)

Provides context for parsing GtkBuilder UI files.

GtkBuildableParseContext is an opaque struct.

Methods¶

get_element¶

def get_element(self) -> str | None

Retrieves the name of the currently open element.

If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see BuildableParseContext.get_element_stack.

get_element_stack¶

def get_element_stack(self) -> list[str]

Retrieves the element stack from the internal state of the parser.

The returned GPtrArray is an array of strings where the last item is the currently open tag (as would be returned by BuildableParseContext.get_element) and the previous item is its immediate parent.

This function is intended to be used in the start_element and end_element handlers where BuildableParseContext.get_element would merely return the name of the element that is being processed.

get_position¶

def get_position(self) -> tuple[int, int]

Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages."

pop¶

def pop(self) -> int | None

Completes the process of a temporary sub-parser redirection.

This function exists to collect the user_data allocated by a matching call to BuildableParseContext.push. It must be called in the end_element handler corresponding to the start_element handler during which BuildableParseContext.push was called. You must not call this function from the error callback -- the user_data is provided directly to the callback in that case.

This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface.

push¶

def push(self, parser: BuildableParser, user_data: int | None = ...) -> None

Temporarily redirects markup data to a sub-parser.

This function may only be called from the start_element handler of a GtkBuildableParser. It must be matched with a corresponding call to BuildableParseContext.pop in the matching end_element handler (except in the case that the parser aborts due to an error).

All tags, text and other data between the matching tags is redirected to the subparser given by parser. user_data is used as the user_data for that parser. user_data is also passed to the error callback in the event that an error occurs. This includes errors that occur in subparsers of the subparser.

The end tag matching the start tag for which this call was made is handled by the previous parser (which is given its own user_data) which is why BuildableParseContext.pop is provided to allow "one last access" to the user_data provided to this function. In the case of error, the user_data provided here is passed directly to the error callback of the subparser and BuildableParseContext.pop should not be called. In either case, if user_data was allocated then it ought to be freed from both of these locations.

This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface.

For an example of how to use this, see GLib.MarkupParseContext.push which has the same kind of API.

Parameters:

parser — a GtkBuildableParser
user_data — user data to pass to GtkBuildableParser functions