forked from AuroraMiddleware/gtk
111 lines
3.6 KiB
XML
111 lines
3.6 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|
]>
|
|
<refentry id="gtk4-builder-tool">
|
|
|
|
<refentryinfo>
|
|
<title>gtk4-builder-tool</title>
|
|
<productname>GTK</productname>
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Matthias</firstname>
|
|
<surname>Clasen</surname>
|
|
</author>
|
|
</authorgroup>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>gtk4-builder-tool</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
<refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gtk4-builder-tool</refname>
|
|
<refpurpose>GtkBuilder file utility</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>gtk4-builder-tool</command>
|
|
<arg choice="opt"><replaceable>COMMAND</replaceable></arg>
|
|
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
|
|
<arg choice="plain"><replaceable>FILE</replaceable></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
<command>gtk4-builder-tool</command> can perform various operations
|
|
on GtkBuilder .ui files.
|
|
</para>
|
|
<para>
|
|
The <option>validate</option> command validates the .ui file and reports
|
|
errors to stderr.
|
|
</para>
|
|
<para>
|
|
The <option>enumerate</option> command lists all the named objects that
|
|
are created in the .ui file.
|
|
</para>
|
|
<para>
|
|
The <option>preview</option> command displays the .ui file. This command
|
|
accepts options to specify the ID of the toplevel object and a .css file
|
|
to use.
|
|
</para>
|
|
<para>
|
|
The <option>simplify</option> command simplifies the .ui file by removing
|
|
properties that are set to their default values and writes the resulting XML
|
|
to stdout, or back to the input file.
|
|
</para>
|
|
<para>
|
|
When the <option>--3to4</option> is specified, <option>simplify</option>
|
|
interprets the input as a GTK 3 ui file and attempts to convert it to GTK 4
|
|
equivalents. It performs various conversions, such as renaming properties,
|
|
translating child properties to layout properties, rewriting the setup for
|
|
GtkNotebook, GtkStack, GtkAssistant or changing toolbars into boxes.
|
|
</para>
|
|
<para>
|
|
You should always test the modified .ui files produced by gtk4-builder-tool
|
|
before using them in production.
|
|
</para>
|
|
<para>
|
|
Note in particular that the conversion
|
|
done with <option>--3to4</option> is meant as a starting point for a port
|
|
from GTK 3 to GTK 4. It is expected that you will have to do manual fixups
|
|
after the initial conversion.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1><title>Simplify Options</title>
|
|
<para>The <option>simplify</option> command accepts the following options:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--replace</option></term>
|
|
<listitem><para>Write the content back to the .ui file instead of stdout.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>--3to4</option></term>
|
|
<listitem><para>Transform a GTK 3 ui file to GTK 4</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1><title>Preview Options</title>
|
|
<para>The <option>preview</option> command accepts the following options:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>--id=<arg choice="plain">ID</arg></option></term>
|
|
<listitem><para>The ID of the object to preview. If not specified,
|
|
gtk4-builder-tool will choose a suitable object on its own.</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>--css=<arg choice="plain">FILE</arg></option></term>
|
|
<listitem><para>Load style information from the given .css file.</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|