264 lines
14 KiB
XML
264 lines
14 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="libgimp-gimpbrushselect">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimpbrushselect</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpbrushselect</refname>
|
|
<refpurpose>Functions providing a brush selection dialog.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="void">void</link> (<link linkend="GimpRunBrushCallback">*GimpRunBrushCallback</link>) (const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
const <link linkend="guchar">guchar</link> *mask_data,
|
|
<link linkend="gboolean">gboolean</link> dialog_closing,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
const <link linkend="gchar">gchar</link>* <link linkend="gimp-brush-select-new">gimp_brush_select_new</link> (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
|
|
<link linkend="GimpRunBrushCallback">GimpRunBrushCallback</link> callback,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="void">void</link> <link linkend="gimp-brush-select-destroy">gimp_brush_select_destroy</link> (const <link linkend="gchar">gchar</link> *brush_callback);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brushes-popup">gimp_brushes_popup</link> (const <link linkend="gchar">gchar</link> *brush_callback,
|
|
const <link linkend="gchar">gchar</link> *popup_title,
|
|
const <link linkend="gchar">gchar</link> *initial_brush,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brushes-close-popup">gimp_brushes_close_popup</link> (const <link linkend="gchar">gchar</link> *brush_callback);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brushes-set-popup">gimp_brushes_set_popup</link> (const <link linkend="gchar">gchar</link> *brush_callback,
|
|
const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Functions providing a brush selection dialog.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpRunBrushCallback" role="function"/>GimpRunBrushCallback ()</title>
|
|
<indexterm><primary>GimpRunBrushCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpRunBrushCallback) (const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
const <link linkend="guchar">guchar</link> *mask_data,
|
|
<link linkend="gboolean">gboolean</link> dialog_closing,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>brush_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>paint_mode</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dialog_closing</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-select-new" role="function"/>gimp_brush_select_new ()</title>
|
|
<indexterm><primary>gimp_brush_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_brush_select_new (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
|
|
<link linkend="GimpRunBrushCallback">GimpRunBrushCallback</link> callback,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>title</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>brush_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>paint_mode</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>callback</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-select-destroy" role="function"/>gimp_brush_select_destroy ()</title>
|
|
<indexterm><primary>gimp_brush_select_destroy</primary></indexterm><programlisting><link linkend="void">void</link> gimp_brush_select_destroy (const <link linkend="gchar">gchar</link> *brush_callback);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>brush_callback</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brushes-popup" role="function"/>gimp_brushes_popup ()</title>
|
|
<indexterm><primary>gimp_brushes_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brushes_popup (const <link linkend="gchar">gchar</link> *brush_callback,
|
|
const <link linkend="gchar">gchar</link> *popup_title,
|
|
const <link linkend="gchar">gchar</link> *initial_brush,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
|
|
<para>
|
|
Invokes the Gimp brush selection.
|
|
</para>
|
|
<para>
|
|
This procedure opens the brush selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>brush_callback</parameter> :</term>
|
|
<listitem><simpara> The callback PDB proc to call when brush selection is made.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>popup_title</parameter> :</term>
|
|
<listitem><simpara> Title of the brush selection dialog.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>initial_brush</parameter> :</term>
|
|
<listitem><simpara> The name of the brush to set as the first selected.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The initial opacity of the brush.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara> The initial spacing of the brush (if < 0 then use brush default spacing).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>paint_mode</parameter> :</term>
|
|
<listitem><simpara> The initial paint mode.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brushes-close-popup" role="function"/>gimp_brushes_close_popup ()</title>
|
|
<indexterm><primary>gimp_brushes_close_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brushes_close_popup (const <link linkend="gchar">gchar</link> *brush_callback);</programlisting>
|
|
<para>
|
|
Close the brush selection dialog.
|
|
</para>
|
|
<para>
|
|
This procedure closes an opened brush selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>brush_callback</parameter> :</term>
|
|
<listitem><simpara> The name of the callback registered for this pop-up.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brushes-set-popup" role="function"/>gimp_brushes_set_popup ()</title>
|
|
<indexterm><primary>gimp_brushes_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brushes_set_popup (const <link linkend="gchar">gchar</link> *brush_callback,
|
|
const <link linkend="gchar">gchar</link> *brush_name,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="gint">gint</link> spacing,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
|
|
<para>
|
|
Sets the current brush in a brush selection dialog.
|
|
</para>
|
|
<para>
|
|
Sets the current brush in a brush selection dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>brush_callback</parameter> :</term>
|
|
<listitem><simpara> The name of the callback registered for this pop-up.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>brush_name</parameter> :</term>
|
|
<listitem><simpara> The name of the brush to set as selected.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The initial opacity of the brush.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara> The initial spacing of the brush (if < 0 then use brush default spacing).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>paint_mode</parameter> :</term>
|
|
<listitem><simpara> The initial paint mode.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1><refsect2 /><refsect2 /></refsect1>
|
|
</refentry>
|