50c8c56fe0
2003-01-05 Sven Neumann <sven@gimp.org> * libgimpwidgets/gimpchainbutton.[ch] * libgimpwidgets/gimpcolorarea.[ch] * libgimpwidgets/gimpcolorbutton.[ch] * libgimpwidgets/gimpdialog.c * libgimpwidgets/gimpfileselection.[ch] * libgimpwidgets/gimpoffsetarea.c * libgimpwidgets/gimppickbutton.c * libgimpwidgets/gimpquerybox.c * libgimpwidgets/gimpwidgets.c: added more API documentation. Declared gimp_scale_entry_new_internal() as static. * libgimpwidgets/gimpwidgets.def: changed accordingly.
84 lines
1.7 KiB
Plaintext
84 lines
1.7 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>
|
|
|
|
|
|
<!-- ##### 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:
|
|
<!-- # Unused Parameters # -->
|
|
@gcb:
|
|
@is_active:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@button:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@gcb:
|
|
|
|
|
|
<!-- ##### SIGNAL GimpChainButton::toggled ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@gimpchainbutton: the object which received the signal.
|
|
|