gtk2/gtk/gtkframe.c
Alberto Ruiz 496f0892fc introspection: This patch fixes nullable return values fixes for the following symbols in gtk
gtk_accel_group_query
  gtk_accel_group_from_accel_closure
  gtk_accel_label_get_accel_widget
  gtk_accessible_get_widget
  gtk_actionable_get_action_name
  gtk_app_chooser_get_app_info
  gtk_app_chooser_button_get_heading
  gtk_app_chooser_dialog_get_heading
  gtk_application_get_window_by_id
  gtk_assistant_get_nth_page
  gtk_binding_set_find
  gtk_builder_get_object
  gtk_builder_lookup_callback_symbol
  gtk_builder_get_application
  gtk_button_get_image
  gtk_cell_area_get_focus_from_sibling
  gtk_cell_renderer_start_editing
  gtk_cell_view_get_model
  gtk_cell_view_get_displayed_row
  gtk_clipboard_get_owner
  gtk_container_get_focus_child
  gtk_container_get_focus_vadjustment
  gtk_container_get_focus_hadjustment
  gtk_dialog_get_widget_for_response
  gtk_drag_get_source_widget
  gtk_drag_dest_get_target_list
  gtk_drag_source_get_target_list
  gtk_entry_completion_get_model
  gtk_entry_completion_compute_prefix
  gtk_expander_get_label_widget
  gtk_file_chooser_get_filename
  gtk_file_chooser_get_current_folder
  gtk_file_chooser_get_uri
  gtk_file_chooser_get_current_folder_uri
  gtk_file_chooser_get_preview_widget
  gtk_file_chooser_get_preview_file
  gtk_file_chooser_get_preview_filename
  gtk_file_chooser_get_preview_uri
  gtk_file_chooser_get_extra_widget
  gtk_file_chooser_get_filter
  gtk_file_chooser_native_get_accept_label
  gtk_file_chooser_native_get_cancel_label
  gtk_file_filter_get_name
  gtk_font_chooser_get_font_family
  gtk_font_chooser_get_font_face
  gtk_font_chooser_get_font
  gtk_font_chooser_get_font_desc
  gtk_font_chooser_get_font_map
  gtk_frame_get_label
  gtk_gesture_get_device
  gtk_gesture_get_window
  gtk_gl_area_get_error
  gtk_header_bar_get_title
  gtk_header_bar_get_subtitle
  gtk_header_bar_get_custom_title
  gtk_icon_info_get_filename
  gtk_icon_view_get_path_at_pos
  gtk_icon_view_get_model
  gtk_image_get_pixbuf
  gtk_image_get_animation
  gtk_label_get_mnemonic_widget
  gtk_label_get_attributes
  gtk_check_version
  gtk_menu_button_get_popup
  gtk_menu_button_get_menu_model
  gtk_menu_button_get_align_widget
  gtk_menu_button_get_popover
  gtk_menu_item_get_submenu
  gtk_menu_item_get_accel_path
  gtk_native_dialog_get_title
  gtk_native_dialog_get_transient_for
  gtk_notebook_get_nth_page
  gtk_notebook_get_tab_label_text
  gtk_notebook_get_menu_label
  gtk_notebook_get_menu_label_text
  gtk_notebook_get_group_name
  gtk_notebook_get_action_widget
  gtk_offscreen_window_get_surface
  gtk_offscreen_window_get_pixbuf
  gtk_paned_get_child1
  gtk_paned_get_child2
  gtk_places_sidebar_get_location
  gtk_places_sidebar_get_nth_bookmark
  gtk_plug_get_socket_window
  gtk_popover_get_default_widget
  gtk_progress_bar_get_text
  gtk_recent_filter_get_name
  gtk_recent_manager_lookup_item
  gtk_settings_get_default
  gtk_socket_get_plug_window
  gtk_stack_sidebar_get_stack
  gtk_stack_switcher_get_stack
  gtk_style_context_get_section
  gtk_style_context_get_parent
  gtk_style_context_get_frame_clock
  gtk_test_find_widget
  gtk_text_buffer_get_mark
  gtk_text_tag_table_lookup
  gtk_text_view_get_tabs
  gtk_text_view_toggle_cursor_visible
  gtk_text_view_get_window
  gtk_toolbar_get_nth_item
  gtk_tool_button_get_label
  gtk_tool_button_get_icon_name
  gtk_tool_button_get_label_widget
  gtk_tool_button_get_icon_widget
  gtk_tool_palette_get_drop_item
  gtk_tool_palette_get_drop_group
  gtk_tree_model_filter_convert_child_path_to_path
  gtk_tree_model_filter_convert_path_to_child_path
  gtk_tree_model_sort_convert_child_path_to_path
  gtk_tree_model_sort_convert_path_to_child_path
  gtk_tree_view_get_column
  gtk_tree_view_get_bin_window
  gtk_tree_view_column_get_widget
  gtk_tree_view_column_get_tree_view
  gtk_widget_get_frame_clock
  gtk_window_group_get_current_device_grab
  GtkTextBufferSerializeFunc
2016-01-08 12:18:23 +00:00

1033 lines
32 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
*
* 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/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include <string.h>
#include "gtkframe.h"
#include "gtklabel.h"
#include "gtkprivate.h"
#include "gtktypebuiltins.h"
#include "gtkintl.h"
#include "gtkbuildable.h"
#include "gtkwidgetpath.h"
#include "gtkcssnodeprivate.h"
#include "gtkcsscustomgadgetprivate.h"
#include "gtkwidgetprivate.h"
#include "gtkcontainerprivate.h"
#include "gtkstylecontextprivate.h"
#include "gtkcssstylepropertyprivate.h"
#include "gtklabel.h"
#include "a11y/gtkframeaccessible.h"
/**
* SECTION:gtkframe
* @Short_description: A bin with a decorative frame and optional label
* @Title: GtkFrame
*
* The frame widget is a bin that surrounds its child with a decorative
* frame and an optional label. If present, the label is drawn in a gap
* in the top side of the frame. The position of the label can be
* controlled with gtk_frame_set_label_align().
*
* # GtkFrame as GtkBuildable
*
* The GtkFrame implementation of the GtkBuildable interface supports
* placing a child in the label position by specifying “label” as the
* “type” attribute of a <child> element. A normal content child can
* be specified without specifying a <child> type attribute.
*
* An example of a UI definition fragment with GtkFrame:
* |[
* <object class="GtkFrame">
* <child type="label">
* <object class="GtkLabel" id="frame-label"/>
* </child>
* <child>
* <object class="GtkEntry" id="frame-content"/>
* </child>
* </object>
* ]|
*
* # CSS nodes
*
* |[<!-- language="plain" -->
* frame
* ├── border
* ├── <label widget>
* ╰── <child>
* ]|
*
* GtkFrame has a main CSS node with name frame and a subnode with
* name border. The border node is used to render the visible border.
* The style class .flat can appear with the main node. In the
* #GtkShortcutsWindow, frames are used with the .keycap style class.
*/
#define LABEL_PAD 1
#define LABEL_SIDE_PAD 2
struct _GtkFramePrivate
{
/* Properties */
GtkWidget *label_widget;
GtkCssGadget *gadget;
GtkCssGadget *border_gadget;
gint16 shadow_type;
gfloat label_xalign;
gfloat label_yalign;
/* Properties */
GtkAllocation child_allocation;
GtkAllocation label_allocation;
};
enum {
PROP_0,
PROP_LABEL,
PROP_LABEL_XALIGN,
PROP_LABEL_YALIGN,
PROP_SHADOW_TYPE,
PROP_LABEL_WIDGET,
LAST_PROP
};
static GParamSpec *frame_props[LAST_PROP];
static void gtk_frame_finalize (GObject *object);
static void gtk_frame_set_property (GObject *object,
guint param_id,
const GValue *value,
GParamSpec *pspec);
static void gtk_frame_get_property (GObject *object,
guint param_id,
GValue *value,
GParamSpec *pspec);
static gboolean gtk_frame_draw (GtkWidget *widget,
cairo_t *cr);
static void gtk_frame_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
static void gtk_frame_remove (GtkContainer *container,
GtkWidget *child);
static void gtk_frame_forall (GtkContainer *container,
gboolean include_internals,
GtkCallback callback,
gpointer callback_data);
static void gtk_frame_compute_child_allocation (GtkFrame *frame,
GtkAllocation *child_allocation);
static void gtk_frame_real_compute_child_allocation (GtkFrame *frame,
GtkAllocation *child_allocation);
/* GtkBuildable */
static void gtk_frame_buildable_init (GtkBuildableIface *iface);
static void gtk_frame_buildable_add_child (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *type);
static void gtk_frame_get_preferred_width (GtkWidget *widget,
gint *minimum_size,
gint *natural_size);
static void gtk_frame_get_preferred_height (GtkWidget *widget,
gint *minimum_size,
gint *natural_size);
static void gtk_frame_get_preferred_height_for_width(GtkWidget *layout,
gint width,
gint *minimum_height,
gint *natural_height);
static void gtk_frame_get_preferred_width_for_height(GtkWidget *layout,
gint width,
gint *minimum_height,
gint *natural_height);
static void gtk_frame_state_flags_changed (GtkWidget *widget,
GtkStateFlags previous_state);
static void gtk_frame_measure (GtkCssGadget *gadget,
GtkOrientation orientation,
gint for_size,
gint *minimum_size,
gint *natural_size,
gint *minimum_baseline,
gint *natural_baseline,
gpointer data);
static void gtk_frame_allocate (GtkCssGadget *gadget,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip,
gpointer data);
static void gtk_frame_allocate_border (GtkCssGadget *gadget,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip,
gpointer data);
static gboolean gtk_frame_render (GtkCssGadget *gadget,
cairo_t *cr,
int x,
int y,
int width,
int height,
gpointer data);
G_DEFINE_TYPE_WITH_CODE (GtkFrame, gtk_frame, GTK_TYPE_BIN,
G_ADD_PRIVATE (GtkFrame)
G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
gtk_frame_buildable_init))
static void
gtk_frame_class_init (GtkFrameClass *class)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
GtkContainerClass *container_class;
gobject_class = (GObjectClass*) class;
widget_class = GTK_WIDGET_CLASS (class);
container_class = GTK_CONTAINER_CLASS (class);
gobject_class->finalize = gtk_frame_finalize;
gobject_class->set_property = gtk_frame_set_property;
gobject_class->get_property = gtk_frame_get_property;
frame_props[PROP_LABEL] =
g_param_spec_string ("label",
P_("Label"),
P_("Text of the frame's label"),
NULL,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
frame_props[PROP_LABEL_XALIGN] =
g_param_spec_float ("label-xalign",
P_("Label xalign"),
P_("The horizontal alignment of the label"),
0.0, 1.0,
0.0,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
frame_props[PROP_LABEL_YALIGN] =
g_param_spec_float ("label-yalign",
P_("Label yalign"),
P_("The vertical alignment of the label"),
0.0, 1.0,
0.5,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
frame_props[PROP_SHADOW_TYPE] =
g_param_spec_enum ("shadow-type",
P_("Frame shadow"),
P_("Appearance of the frame border"),
GTK_TYPE_SHADOW_TYPE,
GTK_SHADOW_ETCHED_IN,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
frame_props[PROP_LABEL_WIDGET] =
g_param_spec_object ("label-widget",
P_("Label widget"),
P_("A widget to display in place of the usual frame label"),
GTK_TYPE_WIDGET,
GTK_PARAM_READWRITE);
g_object_class_install_properties (gobject_class, LAST_PROP, frame_props);
widget_class->draw = gtk_frame_draw;
widget_class->size_allocate = gtk_frame_size_allocate;
widget_class->get_preferred_width = gtk_frame_get_preferred_width;
widget_class->get_preferred_height = gtk_frame_get_preferred_height;
widget_class->get_preferred_height_for_width = gtk_frame_get_preferred_height_for_width;
widget_class->get_preferred_width_for_height = gtk_frame_get_preferred_width_for_height;
widget_class->state_flags_changed = gtk_frame_state_flags_changed;
container_class->remove = gtk_frame_remove;
container_class->forall = gtk_frame_forall;
class->compute_child_allocation = gtk_frame_real_compute_child_allocation;
gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_FRAME_ACCESSIBLE);
gtk_widget_class_set_css_name (widget_class, "frame");
}
static void
gtk_frame_buildable_init (GtkBuildableIface *iface)
{
iface->add_child = gtk_frame_buildable_add_child;
}
static void
gtk_frame_buildable_add_child (GtkBuildable *buildable,
GtkBuilder *builder,
GObject *child,
const gchar *type)
{
if (type && strcmp (type, "label") == 0)
gtk_frame_set_label_widget (GTK_FRAME (buildable), GTK_WIDGET (child));
else if (!type)
gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
else
GTK_BUILDER_WARN_INVALID_CHILD_TYPE (GTK_FRAME (buildable), type);
}
static void
gtk_frame_init (GtkFrame *frame)
{
GtkFramePrivate *priv;
GtkCssNode *widget_node;
frame->priv = gtk_frame_get_instance_private (frame);
priv = frame->priv;
priv->label_widget = NULL;
priv->shadow_type = GTK_SHADOW_ETCHED_IN;
priv->label_xalign = 0.0;
priv->label_yalign = 0.5;
widget_node = gtk_widget_get_css_node (GTK_WIDGET (frame));
priv->gadget = gtk_css_custom_gadget_new_for_node (widget_node,
GTK_WIDGET (frame),
gtk_frame_measure,
gtk_frame_allocate,
gtk_frame_render,
NULL,
NULL);
priv->border_gadget = gtk_css_custom_gadget_new ("border",
GTK_WIDGET (frame),
priv->gadget,
NULL,
NULL,
gtk_frame_allocate_border,
NULL,
NULL,
NULL);
}
static void
gtk_frame_finalize (GObject *object)
{
GtkFrame *frame = GTK_FRAME (object);
GtkFramePrivate *priv = frame->priv;
g_clear_object (&priv->border_gadget);
g_clear_object (&priv->gadget);
G_OBJECT_CLASS (gtk_frame_parent_class)->finalize (object);
}
static void
gtk_frame_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkFrame *frame = GTK_FRAME (object);
GtkFramePrivate *priv = frame->priv;
switch (prop_id)
{
case PROP_LABEL:
gtk_frame_set_label (frame, g_value_get_string (value));
break;
case PROP_LABEL_XALIGN:
gtk_frame_set_label_align (frame, g_value_get_float (value),
priv->label_yalign);
break;
case PROP_LABEL_YALIGN:
gtk_frame_set_label_align (frame, priv->label_xalign,
g_value_get_float (value));
break;
case PROP_SHADOW_TYPE:
gtk_frame_set_shadow_type (frame, g_value_get_enum (value));
break;
case PROP_LABEL_WIDGET:
gtk_frame_set_label_widget (frame, g_value_get_object (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gtk_frame_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkFrame *frame = GTK_FRAME (object);
GtkFramePrivate *priv = frame->priv;
switch (prop_id)
{
case PROP_LABEL:
g_value_set_string (value, gtk_frame_get_label (frame));
break;
case PROP_LABEL_XALIGN:
g_value_set_float (value, priv->label_xalign);
break;
case PROP_LABEL_YALIGN:
g_value_set_float (value, priv->label_yalign);
break;
case PROP_SHADOW_TYPE:
g_value_set_enum (value, priv->shadow_type);
break;
case PROP_LABEL_WIDGET:
g_value_set_object (value,
priv->label_widget ?
G_OBJECT (priv->label_widget) : NULL);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/**
* gtk_frame_new:
* @label: (allow-none): the text to use as the label of the frame
*
* Creates a new #GtkFrame, with optional label @label.
* If @label is %NULL, the label is omitted.
*
* Returns: a new #GtkFrame widget
**/
GtkWidget*
gtk_frame_new (const gchar *label)
{
return g_object_new (GTK_TYPE_FRAME, "label", label, NULL);
}
static void
gtk_frame_remove (GtkContainer *container,
GtkWidget *child)
{
GtkFrame *frame = GTK_FRAME (container);
GtkFramePrivate *priv = frame->priv;
if (priv->label_widget == child)
gtk_frame_set_label_widget (frame, NULL);
else
GTK_CONTAINER_CLASS (gtk_frame_parent_class)->remove (container, child);
}
static void
gtk_frame_forall (GtkContainer *container,
gboolean include_internals,
GtkCallback callback,
gpointer callback_data)
{
GtkBin *bin = GTK_BIN (container);
GtkFrame *frame = GTK_FRAME (container);
GtkFramePrivate *priv = frame->priv;
GtkWidget *child;
child = gtk_bin_get_child (bin);
if (child)
(* callback) (child, callback_data);
if (priv->label_widget)
(* callback) (priv->label_widget, callback_data);
}
/**
* gtk_frame_set_label:
* @frame: a #GtkFrame
* @label: (allow-none): the text to use as the label of the frame
*
* Sets the text of the label. If @label is %NULL,
* the current label is removed.
**/
void
gtk_frame_set_label (GtkFrame *frame,
const gchar *label)
{
g_return_if_fail (GTK_IS_FRAME (frame));
if (!label)
{
gtk_frame_set_label_widget (frame, NULL);
}
else
{
GtkWidget *child = gtk_label_new (label);
gtk_widget_show (child);
gtk_frame_set_label_widget (frame, child);
}
}
/**
* gtk_frame_get_label:
* @frame: a #GtkFrame
*
* If the frames label widget is a #GtkLabel, returns the
* text in the label widget. (The frame will have a #GtkLabel
* for the label widget if a non-%NULL argument was passed
* to gtk_frame_new().)
*
* Returns: (nullable): the text in the label, or %NULL if there
* was no label widget or the lable widget was not
* a #GtkLabel. This string is owned by GTK+ and
* must not be modified or freed.
**/
const gchar *
gtk_frame_get_label (GtkFrame *frame)
{
GtkFramePrivate *priv;
g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
priv = frame->priv;
if (GTK_IS_LABEL (priv->label_widget))
return gtk_label_get_text (GTK_LABEL (priv->label_widget));
else
return NULL;
}
/**
* gtk_frame_set_label_widget:
* @frame: a #GtkFrame
* @label_widget: (nullable): the new label widget
*
* Sets the label widget for the frame. This is the widget that
* will appear embedded in the top edge of the frame as a
* title.
**/
void
gtk_frame_set_label_widget (GtkFrame *frame,
GtkWidget *label_widget)
{
GtkFramePrivate *priv;
gboolean need_resize = FALSE;
g_return_if_fail (GTK_IS_FRAME (frame));
g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
g_return_if_fail (label_widget == NULL || gtk_widget_get_parent (label_widget) == NULL);
priv = frame->priv;
if (priv->label_widget == label_widget)
return;
if (priv->label_widget)
{
need_resize = gtk_widget_get_visible (priv->label_widget);
gtk_widget_unparent (priv->label_widget);
}
priv->label_widget = label_widget;
if (label_widget)
{
priv->label_widget = label_widget;
gtk_widget_set_parent (label_widget, GTK_WIDGET (frame));
need_resize |= gtk_widget_get_visible (label_widget);
}
if (gtk_widget_get_visible (GTK_WIDGET (frame)) && need_resize)
gtk_widget_queue_resize (GTK_WIDGET (frame));
g_object_freeze_notify (G_OBJECT (frame));
g_object_notify_by_pspec (G_OBJECT (frame), frame_props[PROP_LABEL_WIDGET]);
g_object_notify_by_pspec (G_OBJECT (frame), frame_props[PROP_LABEL]);
g_object_thaw_notify (G_OBJECT (frame));
}
/**
* gtk_frame_get_label_widget:
* @frame: a #GtkFrame
*
* Retrieves the label widget for the frame. See
* gtk_frame_set_label_widget().
*
* Returns: (nullable) (transfer none): the label widget, or %NULL if
* there is none.
**/
GtkWidget *
gtk_frame_get_label_widget (GtkFrame *frame)
{
g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
return frame->priv->label_widget;
}
/**
* gtk_frame_set_label_align:
* @frame: a #GtkFrame
* @xalign: The position of the label along the top edge
* of the widget. A value of 0.0 represents left alignment;
* 1.0 represents right alignment.
* @yalign: The y alignment of the label. A value of 0.0 aligns under
* the frame; 1.0 aligns above the frame. If the values are exactly
* 0.0 or 1.0 the gap in the frame wont be painted because the label
* will be completely above or below the frame.
*
* Sets the alignment of the frame widgets label. The
* default values for a newly created frame are 0.0 and 0.5.
**/
void
gtk_frame_set_label_align (GtkFrame *frame,
gfloat xalign,
gfloat yalign)
{
GtkFramePrivate *priv;
g_return_if_fail (GTK_IS_FRAME (frame));
priv = frame->priv;
xalign = CLAMP (xalign, 0.0, 1.0);
yalign = CLAMP (yalign, 0.0, 1.0);
g_object_freeze_notify (G_OBJECT (frame));
if (xalign != priv->label_xalign)
{
priv->label_xalign = xalign;
g_object_notify_by_pspec (G_OBJECT (frame), frame_props[PROP_LABEL_XALIGN]);
}
if (yalign != priv->label_yalign)
{
priv->label_yalign = yalign;
g_object_notify_by_pspec (G_OBJECT (frame), frame_props[PROP_LABEL_YALIGN]);
}
g_object_thaw_notify (G_OBJECT (frame));
gtk_widget_queue_resize (GTK_WIDGET (frame));
}
/**
* gtk_frame_get_label_align:
* @frame: a #GtkFrame
* @xalign: (out) (allow-none): location to store X alignment of
* frames label, or %NULL
* @yalign: (out) (allow-none): location to store X alignment of
* frames label, or %NULL
*
* Retrieves the X and Y alignment of the frames label. See
* gtk_frame_set_label_align().
**/
void
gtk_frame_get_label_align (GtkFrame *frame,
gfloat *xalign,
gfloat *yalign)
{
GtkFramePrivate *priv;
g_return_if_fail (GTK_IS_FRAME (frame));
priv = frame->priv;
if (xalign)
*xalign = priv->label_xalign;
if (yalign)
*yalign = priv->label_yalign;
}
/**
* gtk_frame_set_shadow_type:
* @frame: a #GtkFrame
* @type: the new #GtkShadowType
*
* Sets the shadow type for @frame.
**/
void
gtk_frame_set_shadow_type (GtkFrame *frame,
GtkShadowType type)
{
GtkFramePrivate *priv;
g_return_if_fail (GTK_IS_FRAME (frame));
priv = frame->priv;
if ((GtkShadowType) priv->shadow_type != type)
{
priv->shadow_type = type;
if (type == GTK_SHADOW_NONE)
gtk_css_gadget_add_class (priv->border_gadget, GTK_STYLE_CLASS_FLAT);
else
gtk_css_gadget_remove_class (priv->border_gadget, GTK_STYLE_CLASS_FLAT);
g_object_notify_by_pspec (G_OBJECT (frame), frame_props[PROP_SHADOW_TYPE]);
}
}
/**
* gtk_frame_get_shadow_type:
* @frame: a #GtkFrame
*
* Retrieves the shadow type of the frame. See
* gtk_frame_set_shadow_type().
*
* Returns: the current shadow type of the frame.
**/
GtkShadowType
gtk_frame_get_shadow_type (GtkFrame *frame)
{
g_return_val_if_fail (GTK_IS_FRAME (frame), GTK_SHADOW_ETCHED_IN);
return frame->priv->shadow_type;
}
static gboolean
gtk_frame_draw (GtkWidget *widget,
cairo_t *cr)
{
gtk_css_gadget_draw (GTK_FRAME (widget)->priv->gadget, cr);
return FALSE;
}
static gboolean
gtk_frame_render (GtkCssGadget *gadget,
cairo_t *cr,
int x,
int y,
int width,
int height,
gpointer data)
{
GtkWidget *widget;
GtkFramePrivate *priv;
gint xc, yc, w, h;
GtkAllocation allocation;
widget = gtk_css_gadget_get_owner (gadget);
priv = GTK_FRAME (widget)->priv;
cairo_save (cr);
gtk_widget_get_allocation (widget, &allocation);
/* We want to use the standard gadget drawing for the border,
* so we clip out the label allocation in order to get the
* frame gap.
*/
xc = priv->label_allocation.x - allocation.x;
yc = y;
w = priv->label_allocation.width;
h = priv->label_allocation.height;
if (GTK_IS_LABEL (priv->label_widget))
{
PangoRectangle ink_rect;
/* Shrink the clip area for labels, so we get unclipped
* frames for the yalign 0.0 and 1.0 cases.
*/
pango_layout_get_pixel_extents (gtk_label_get_layout (GTK_LABEL (priv->label_widget)), &ink_rect, NULL);
yc += (h - ink_rect.height) / 2;
h = ink_rect.height;
}
cairo_rectangle (cr, 0, 0, allocation.width, allocation.height);
cairo_rectangle (cr, xc + w, yc, - w, h);
cairo_set_fill_rule (cr, CAIRO_FILL_RULE_WINDING);
cairo_clip (cr);
gtk_css_gadget_draw (priv->border_gadget, cr);
cairo_restore (cr);
GTK_WIDGET_CLASS (gtk_frame_parent_class)->draw (widget, cr);
return FALSE;
}
static void
gtk_frame_size_allocate (GtkWidget *widget,
GtkAllocation *allocation)
{
GtkAllocation clip;
gtk_widget_set_allocation (widget, allocation);
gtk_css_gadget_allocate (GTK_FRAME (widget)->priv->gadget,
allocation,
gtk_widget_get_allocated_baseline (widget),
&clip);
gtk_widget_set_clip (widget, &clip);
}
static void
gtk_frame_allocate (GtkCssGadget *gadget,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip,
gpointer data)
{
GtkWidget *widget;
GtkFrame *frame;
GtkFramePrivate *priv;
GtkAllocation new_allocation;
GtkAllocation frame_allocation;
gint height_extra;
GtkAllocation clip;
widget = gtk_css_gadget_get_owner (gadget);
frame = GTK_FRAME (widget);
priv = frame->priv;
gtk_frame_compute_child_allocation (frame, &new_allocation);
priv->child_allocation = new_allocation;
if (priv->label_widget && gtk_widget_get_visible (priv->label_widget))
{
gint nat_width, width, height;
gfloat xalign;
if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
xalign = priv->label_xalign;
else
xalign = 1 - priv->label_xalign;
gtk_widget_get_preferred_width (priv->label_widget, NULL, &nat_width);
width = MIN (new_allocation.width, nat_width);
gtk_widget_get_preferred_height_for_width (priv->label_widget, width, &height, NULL);
priv->label_allocation.x = new_allocation.x + (new_allocation.width - width) * xalign;
priv->label_allocation.y = new_allocation.y - height;
priv->label_allocation.height = height;
priv->label_allocation.width = width;
gtk_widget_size_allocate (priv->label_widget, &priv->label_allocation);
height_extra = (1 - priv->label_yalign) * height;
}
else
height_extra = 0;
frame_allocation.x = priv->child_allocation.x;
frame_allocation.y = priv->child_allocation.y - height_extra;
frame_allocation.width = priv->child_allocation.width;
frame_allocation.height = priv->child_allocation.height + height_extra;
gtk_css_gadget_allocate (priv->border_gadget,
&frame_allocation,
-1,
&clip);
gtk_container_get_children_clip (GTK_CONTAINER (widget), out_clip);
gdk_rectangle_union (out_clip, &clip, out_clip);
}
static void
gtk_frame_allocate_border (GtkCssGadget *gadget,
const GtkAllocation *allocation,
int baseline,
GtkAllocation *out_clip,
gpointer data)
{
GtkWidget *widget;
GtkWidget *child;
widget = gtk_css_gadget_get_owner (gadget);
child = gtk_bin_get_child (GTK_BIN (widget));
if (child && gtk_widget_get_visible (child))
gtk_widget_size_allocate (child, (GtkAllocation *)allocation);
*out_clip = *allocation;
}
static void
gtk_frame_compute_child_allocation (GtkFrame *frame,
GtkAllocation *child_allocation)
{
g_return_if_fail (GTK_IS_FRAME (frame));
g_return_if_fail (child_allocation != NULL);
GTK_FRAME_GET_CLASS (frame)->compute_child_allocation (frame, child_allocation);
}
static void
gtk_frame_real_compute_child_allocation (GtkFrame *frame,
GtkAllocation *child_allocation)
{
GtkFramePrivate *priv = frame->priv;
GtkAllocation allocation;
gint border_width, height;
gtk_css_gadget_get_content_allocation (priv->gadget, &allocation, NULL);
border_width = gtk_container_get_border_width (GTK_CONTAINER (frame));
if (priv->label_widget)
{
gint nat_width, width;
gtk_widget_get_preferred_width (priv->label_widget, NULL, &nat_width);
width = MIN (allocation.width - 2 * border_width, nat_width);
gtk_widget_get_preferred_height_for_width (priv->label_widget, width, &height, NULL);
}
else
height = 0;
child_allocation->x = allocation.x + border_width;
child_allocation->y = allocation.y + border_width + height;
child_allocation->width = MAX (1, allocation.width - 2 * border_width);
child_allocation->height = MAX (1, allocation.height - 2 * border_width - height);
}
static void
gtk_frame_measure (GtkCssGadget *gadget,
GtkOrientation orientation,
int for_size,
int *minimum,
int *natural,
int *minimum_baseline,
int *natural_baseline,
gpointer data)
{
GtkWidget *widget;
GtkFrame *frame;
GtkFramePrivate *priv;
GtkWidget *child;
gint child_min, child_nat;
guint border_width;
widget = gtk_css_gadget_get_owner (gadget);
frame = GTK_FRAME (widget);
priv = frame->priv;
border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
if (priv->label_widget && gtk_widget_get_visible (priv->label_widget))
{
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
gtk_widget_get_preferred_width (priv->label_widget, &child_min, &child_nat);
*minimum = child_min;
*natural = child_nat;
}
else
{
if (for_size > 0)
gtk_widget_get_preferred_height_for_width (priv->label_widget,
for_size - 2 * border_width, &child_min, &child_nat);
else
gtk_widget_get_preferred_height (priv->label_widget, &child_min, &child_nat);
*minimum = child_min;
*natural = child_nat;
}
}
else
{
*minimum = 0;
*natural = 0;
}
child = gtk_bin_get_child (GTK_BIN (widget));
if (child && gtk_widget_get_visible (child))
{
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
gtk_widget_get_preferred_width (child, &child_min, &child_nat);
*minimum = MAX (*minimum, child_min);
*natural = MAX (*natural, child_nat);
}
else
{
if (for_size > 0)
gtk_widget_get_preferred_height_for_width (child, for_size - 2 * border_width, &child_min, &child_nat);
else
gtk_widget_get_preferred_height (child, &child_min, &child_nat);
*minimum += child_min;
*natural += child_nat;
}
}
*minimum += 2 * border_width;
*natural += 2 * border_width;
}
static void
gtk_frame_get_preferred_width (GtkWidget *widget,
gint *minimum,
gint *natural)
{
gtk_css_gadget_get_preferred_size (GTK_FRAME (widget)->priv->gadget,
GTK_ORIENTATION_HORIZONTAL,
-1,
minimum, natural,
NULL, NULL);
}
static void
gtk_frame_get_preferred_width_for_height (GtkWidget *widget,
gint height,
gint *minimum,
gint *natural)
{
gtk_css_gadget_get_preferred_size (GTK_FRAME (widget)->priv->gadget,
GTK_ORIENTATION_HORIZONTAL,
height,
minimum, natural,
NULL, NULL);
}
static void
gtk_frame_get_preferred_height (GtkWidget *widget,
gint *minimum,
gint *natural)
{
gtk_css_gadget_get_preferred_size (GTK_FRAME (widget)->priv->gadget,
GTK_ORIENTATION_VERTICAL,
-1,
minimum, natural,
NULL, NULL);
}
static void
gtk_frame_get_preferred_height_for_width (GtkWidget *widget,
gint width,
gint *minimum,
gint *natural)
{
gtk_css_gadget_get_preferred_size (GTK_FRAME (widget)->priv->gadget,
GTK_ORIENTATION_VERTICAL,
width,
minimum, natural,
NULL, NULL);
}
static void
gtk_frame_state_flags_changed (GtkWidget *widget,
GtkStateFlags previous_state)
{
GtkCssNode *border_node;
border_node = gtk_css_gadget_get_node (GTK_FRAME (widget)->priv->border_gadget);
gtk_css_node_set_state (border_node, gtk_widget_get_state_flags (widget));
GTK_WIDGET_CLASS (gtk_frame_parent_class)->state_flags_changed (widget, previous_state);
}