117 lines
5.0 KiB
XML
117 lines
5.0 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="GimpPickButton">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="GimpPickButton.top_of_page">GimpPickButton</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpPickButton</refname>
|
|
<refpurpose>Widget to pick a color from screen.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="GimpPickButton.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="GimpPickButton-struct">GimpPickButton</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pick-button-new">gimp_pick_button_new</link> (void);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id="GimpPickButton.object-hierarchy" role="object_hierarchy">
|
|
<title role="object_hierarchy.title">Object Hierarchy</title>
|
|
<synopsis>
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
|
|
+----<link linkend="GtkObject">GtkObject</link>
|
|
+----<link linkend="GtkWidget">GtkWidget</link>
|
|
+----<link linkend="GtkContainer">GtkContainer</link>
|
|
+----<link linkend="GtkBin">GtkBin</link>
|
|
+----<link linkend="GtkButton">GtkButton</link>
|
|
+----GimpPickButton
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpPickButton.implemented-interfaces" role="impl_interfaces">
|
|
<title role="impl_interfaces.title">Implemented Interfaces</title>
|
|
<para>
|
|
GimpPickButton implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpPickButton.signals" role="signal_proto">
|
|
<title role="signal_proto.title">Signals</title>
|
|
<synopsis>
|
|
"<link linkend="GimpPickButton-color-picked">color-picked</link>" : Run First
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="GimpPickButton.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
<link linkend="GimpPickButton"><type>GimpPickButton</type></link> is a specialized button. When clicked, it changes the
|
|
cursor to a color-picker pipette and allows the user to pick a color
|
|
from any point on the screen.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="GimpPickButton.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="GimpPickButton-struct" role="struct">
|
|
<title>GimpPickButton</title>
|
|
<indexterm zone="GimpPickButton-struct"><primary>GimpPickButton</primary></indexterm><programlisting>typedef struct _GimpPickButton GimpPickButton;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-pick-button-new" role="function">
|
|
<title>gimp_pick_button_new ()</title>
|
|
<indexterm zone="gimp-pick-button-new"><primary>gimp_pick_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pick_button_new (void);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 id="GimpPickButton.signal-details" role="signals">
|
|
<title role="signals.title">Signal Details</title>
|
|
<refsect2 id="GimpPickButton-color-picked"><title>The <literal>"color-picked"</literal> signal</title>
|
|
<indexterm zone="GimpPickButton-color-picked"><primary>GimpPickButton::color-picked</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPickButton">GimpPickButton</link> *gimppickbutton,
|
|
<link linkend="gpointer">gpointer</link> arg1,
|
|
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>gimppickbutton</parameter> :</term>
|
|
<listitem><simpara>the object which received the signal.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>arg1</parameter> :</term>
|
|
<listitem><simpara>pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> structure that holds the picked color
|
|
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|