120 lines
4.2 KiB
XML
120 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="GimpFrame">
|
|
<refmeta>
|
|
<refentrytitle>GimpFrame</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpFrame</refname><refpurpose>A widget providing a HIG-compliant subclass of <link linkend="GtkFrame"><type>GtkFrame</type></link>.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GimpFrame-struct">GimpFrame</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-frame-new">gimp_frame_new</link> (const <link linkend="gchar">gchar</link> *label);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GtkObject">GtkObject</link>
|
|
+----<link linkend="GtkWidget">GtkWidget</link>
|
|
+----<link linkend="GtkContainer">GtkContainer</link>
|
|
+----<link linkend="GtkBin">GtkBin</link>
|
|
+----<link linkend="GtkFrame">GtkFrame</link>
|
|
+----GimpFrame
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Implemented Interfaces</title>
|
|
<para>
|
|
GimpFrame implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Style Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpFrame--label-bold">label-bold</link>" <link linkend="gboolean">gboolean</link> : Read
|
|
"<link linkend="GimpFrame--label-spacing">label-spacing</link>" <link linkend="gint">gint</link> : Read
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
A widget providing a HIG-compliant subclass of <link linkend="GtkFrame"><type>GtkFrame</type></link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpFrame-struct"/>GimpFrame</title>
|
|
<indexterm><primary>GimpFrame</primary></indexterm><programlisting>typedef struct _GimpFrame GimpFrame;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-frame-new"/>gimp_frame_new ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_frame_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_frame_new (const <link linkend="gchar">gchar</link> *label);</programlisting>
|
|
<para>
|
|
Creates a <link linkend="GimpFrame"><type>GimpFrame</type></link> widget. A <link linkend="GimpFrame"><type>GimpFrame</type></link> is a HIG-compliant
|
|
variant of <link linkend="GtkFrame"><type>GtkFrame</type></link>. It doesn't render a frame at all but
|
|
otherwise behaves like a frame. The frame's title is rendered in
|
|
bold and the frame content is indented four spaces as suggested by
|
|
the GNOME HIG (see http://developer.gnome.org/projects/gup/hig/).</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>label</parameter> :</term>
|
|
<listitem><simpara> text to set as the frame's title label (or <literal>NULL</literal> for no title)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpFrame"><type>GimpFrame</type></link> widget
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para>Since GIMP 2.2
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Style Properties</title>
|
|
<refsect2><title><anchor id="GimpFrame--label-bold"/>The "<literal>label-bold</literal>" style property</title>
|
|
<programlisting> "label-bold" <link linkend="gboolean">gboolean</link> : Read</programlisting>
|
|
<para></para><para>Default value: TRUE</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GimpFrame--label-spacing"/>The "<literal>label-spacing</literal>" style property</title>
|
|
<programlisting> "label-spacing" <link linkend="gint">gint</link> : Read</programlisting>
|
|
<para></para><para>Allowed values: >= 0</para>
|
|
<para>Default value: 6</para>
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|