gimp/devel-docs/libgimpwidgets/tmpl/gimpchainbutton.sgml

79 lines
1.6 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>
<!-- ##### SIGNAL GimpChainButton::toggled ##### -->
<para>
</para>
@gimpchainbutton: the object which received the signal.
<!-- ##### ENUM GimpChainPosition ##### -->
<para>
</para>
@GIMP_CHAIN_TOP:
@GIMP_CHAIN_LEFT:
@GIMP_CHAIN_BOTTOM:
@GIMP_CHAIN_RIGHT:
<!-- ##### FUNCTION gimp_chain_button_new ##### -->
<para>
</para>
@position:
@Returns:
<!-- ##### FUNCTION gimp_chain_button_set_active ##### -->
<para>
</para>
@button:
@active:
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
<para>
</para>
@button:
@Returns: