gtk2/gtk/gtkorientable.c
Matthias Clasen 929a56e53c Clean up lots of GTK+ -> GTK
Replace most remaining uses of GTK+ in the docs and
user-visible strings by GTK. Also remove some leftover
"Was added in 3.x" sentences from the docs.
2020-09-12 12:01:04 -04:00

108 lines
3.3 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* gtkorientable.c
* Copyright (C) 2008 Imendio AB
* Contact: Michael Natterer <mitch@imendio.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "gtkorientable.h"
#include "gtkprivate.h"
#include "gtkwidgetprivate.h"
#include "gtkstylecontext.h"
#include "gtktypebuiltins.h"
#include "gtkintl.h"
/**
* SECTION:gtkorientable
* @Short_description: An interface for flippable widgets
* @Title: GtkOrientable
*
* The #GtkOrientable interface is implemented by all widgets that can be
* oriented horizontally or vertically. #GtkOrientable is more flexible in that
* it allows the orientation to be changed at runtime, allowing the widgets
* to “flip”.
*/
typedef GtkOrientableIface GtkOrientableInterface;
G_DEFINE_INTERFACE (GtkOrientable, gtk_orientable, G_TYPE_OBJECT)
static void
gtk_orientable_default_init (GtkOrientableInterface *iface)
{
/**
* GtkOrientable:orientation:
*
* The orientation of the orientable.
**/
g_object_interface_install_property (iface,
g_param_spec_enum ("orientation",
P_("Orientation"),
P_("The orientation of the orientable"),
GTK_TYPE_ORIENTATION,
GTK_ORIENTATION_HORIZONTAL,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
}
/**
* gtk_orientable_set_orientation:
* @orientable: a #GtkOrientable
* @orientation: the orientables new orientation.
*
* Sets the orientation of the @orientable.
**/
void
gtk_orientable_set_orientation (GtkOrientable *orientable,
GtkOrientation orientation)
{
g_return_if_fail (GTK_IS_ORIENTABLE (orientable));
g_object_set (orientable,
"orientation", orientation,
NULL);
if (GTK_IS_WIDGET (orientable))
gtk_widget_update_orientation (GTK_WIDGET (orientable), orientation);
}
/**
* gtk_orientable_get_orientation:
* @orientable: a #GtkOrientable
*
* Retrieves the orientation of the @orientable.
*
* Returns: the orientation of the @orientable.
**/
GtkOrientation
gtk_orientable_get_orientation (GtkOrientable *orientable)
{
GtkOrientation orientation;
g_return_val_if_fail (GTK_IS_ORIENTABLE (orientable),
GTK_ORIENTATION_HORIZONTAL);
g_object_get (orientable,
"orientation", &orientation,
NULL);
return orientation;
}