7b6dffa66a
2000-02-18 Michael Natterer <mitch@gimp.org> * libgimp/gimpchainbutton.c * libgimp/gimpcolorbutton.c: documentation updates. 2000-02-18 Michael Natterer <mitch@gimp.org> * libgimp/Makefile.am * libgimp/tmpl/gimpvector.sgml * libgimp/tmpl/gimppixmap.sgml: new files. * libgimp/libgimp-decl.txt * libgimp/libgimp-docs.sgml * libgimp/libgimp-sections.txt * libgimp/libgimp.hierarchy * libgimp/libgimp.types * libgimp/tmpl/gimpchainbutton.sgml * libgimp/tmpl/gimpcolorbutton.sgml * libgimp/tmpl/gimpdialog.sgml * libgimp/tmpl/gimpfileselection.sgml * libgimp/tmpl/gimphelpui.sgml * libgimp/tmpl/gimpmath.sgml * libgimp/tmpl/gimpmatrix.sgml * libgimp/tmpl/gimpmenu.sgml * libgimp/tmpl/gimppatheditor.sgml * libgimp/tmpl/gimpsizeentry.sgml * libgimp/tmpl/gimpunitmenu.sgml * libgimp/tmpl/gimpwidgets.sgml * libgimp/tmpl/libgimp-unused.sgml: various minor updates. Added short descriptions for all libgimpui sections.
85 lines
2.1 KiB
Plaintext
85 lines
2.1 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GimpChainButton
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Widget to visually connect two entry widgets.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
This widget provides a button showing either a linked or a broken
|
|
chain that can be used to link two entries, spinbuttons, colors
|
|
or other GUI elements and show that they may be locked. Use it for
|
|
example to connect X and Y ratios to provide the possibility of a
|
|
constrained aspect ratio.
|
|
</para>
|
|
<para>
|
|
The #GimpChainButton only gives visual feedback, it does not really
|
|
connect widgets. You have to take care of locking the values yourself
|
|
by checking the state of the #GimpChainButton whenever a value changes
|
|
in one of the connected widgets and adjusting the other value if
|
|
necessary.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
You may want to use the convenience function gimp_coordinates_new() to set
|
|
up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GimpChainButton ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### MACRO GIMP_CHAIN_BUTTON ##### -->
|
|
<para>
|
|
Checks if the passed pointer is a pointer to a #GimpChainButton and
|
|
performs the cast if valid.
|
|
</para>
|
|
|
|
@obj: The pointer to cast.
|
|
|
|
|
|
<!-- ##### ENUM GimpChainPosition ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GIMP_CHAIN_TOP: Use if the GimpChainButton is used attached to the top of
|
|
the widgets it connects.
|
|
@GIMP_CHAIN_LEFT: Use if the GimpChainButton is used attached to the left of
|
|
the widgets it connects.
|
|
@GIMP_CHAIN_BOTTOM: Use if the GimpChainButton is used attached to the bottom
|
|
of the widgets it connects.
|
|
@GIMP_CHAIN_RIGHT: Use if the GimpChainButton is used attached to the right of
|
|
the widgets it connects.
|
|
|
|
<!-- ##### FUNCTION gimp_chain_button_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@position:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_chain_button_set_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gcb:
|
|
@is_active:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gcb:
|
|
@Returns:
|
|
|
|
|