/* 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, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/*

 * 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 "gtkintl.h"

#include "gtkbuildable.h"

#include "gtkalias.h"

#define LABEL_PAD 1

#define LABEL_SIDE_PAD 2

enum {

  PROP_0,

  PROP_LABEL,

  PROP_LABEL_XALIGN,

  PROP_LABEL_YALIGN,

  PROP_SHADOW,

  PROP_SHADOW_TYPE,

  PROP_LABEL_WIDGET

};

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 void gtk_frame_paint         (GtkWidget      *widget,

				     GdkRectangle   *area);

static gint gtk_frame_expose        (GtkWidget      *widget,

				     GdkEventExpose *event);

static void gtk_frame_size_request  (GtkWidget      *widget,

				     GtkRequisition *requisition);

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);

G_DEFINE_TYPE_WITH_CODE (GtkFrame, gtk_frame, GTK_TYPE_BIN,

			 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->set_property = gtk_frame_set_property;

  gobject_class->get_property = gtk_frame_get_property;

  g_object_class_install_property (gobject_class,

                                   PROP_LABEL,

                                   g_param_spec_string ("label",

                                                        P_("Label"),

                                                        P_("Text of the frame's label"),

                                                        NULL,

                                                        GTK_PARAM_READABLE |

							GTK_PARAM_WRITABLE));

  g_object_class_install_property (gobject_class,

				   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_object_class_install_property (gobject_class,

				   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_object_class_install_property (gobject_class,

                                   PROP_SHADOW,

                                   g_param_spec_enum ("shadow", NULL,

                                                      P_("Deprecated property, use shadow_type instead"),

						      GTK_TYPE_SHADOW_TYPE,

						      GTK_SHADOW_ETCHED_IN,

                                                      GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));

  g_object_class_install_property (gobject_class,

                                   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_object_class_install_property (gobject_class,

                                   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));

  widget_class->expose_event = gtk_frame_expose;

  widget_class->size_request = gtk_frame_size_request;

  widget_class->size_allocate = gtk_frame_size_allocate;

  container_class->remove = gtk_frame_remove;

  container_class->forall = gtk_frame_forall;

  class->compute_child_allocation = gtk_frame_real_compute_child_allocation;

}

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)

{

  frame->label_widget = NULL;

  frame->shadow_type = GTK_SHADOW_ETCHED_IN;

  frame->label_xalign = 0.0;

  frame->label_yalign = 0.5;

}

static void 

gtk_frame_set_property (GObject         *object,

			guint            prop_id,

			const GValue    *value,

			GParamSpec      *pspec)

{

  GtkFrame *frame;

  frame = GTK_FRAME (object);

  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), 

				 frame->label_yalign);

      break;

    case PROP_LABEL_YALIGN:

      gtk_frame_set_label_align (frame, frame->label_xalign, 

				 g_value_get_float (value));

      break;

    case PROP_SHADOW:

    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;

  frame = GTK_FRAME (object);

  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, frame->label_xalign);

      break;

    case PROP_LABEL_YALIGN:

      g_value_set_float (value, frame->label_yalign);

      break;

    case PROP_SHADOW:

    case PROP_SHADOW_TYPE:

      g_value_set_enum (value, frame->shadow_type);

      break;

    case PROP_LABEL_WIDGET:

      g_value_set_object (value,

                          frame->label_widget ?

                          G_OBJECT (frame->label_widget) : NULL);

      break;

    default:

      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);

      break;

    }

}

/**

 * gtk_frame_new:

 * @label: 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.

 * 

 * Return value: 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);

  if (frame->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);

  if (bin->child)

    (* callback) (bin->child, callback_data);

  if (frame->label_widget)

    (* callback) (frame->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 frame's 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().)

 * 

 * Return value: 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)

{

  g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);

  if (GTK_IS_LABEL (frame->label_widget))

    return gtk_label_get_text (GTK_LABEL (frame->label_widget));

  else

    return NULL;

}

/**

 * gtk_frame_set_label_widget:

 * @frame: a #GtkFrame

 * @label_widget: 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)

{

  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 || label_widget->parent == NULL);

  if (frame->label_widget == label_widget)

    return;

  if (frame->label_widget)

    {

      need_resize = gtk_widget_get_visible (frame->label_widget);

      gtk_widget_unparent (frame->label_widget);

    }

  frame->label_widget = label_widget;

  if (label_widget)

    {

      frame->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 (G_OBJECT (frame), "label-widget");

  g_object_notify (G_OBJECT (frame), "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().

 *

 * Return value: (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->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 won't be painted because the label

 *   will be completely above or below the frame.

 * 

 * Sets the alignment of the frame widget's 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)

{

  g_return_if_fail (GTK_IS_FRAME (frame));

  xalign = CLAMP (xalign, 0.0, 1.0);

  yalign = CLAMP (yalign, 0.0, 1.0);

  g_object_freeze_notify (G_OBJECT (frame));

  if (xalign != frame->label_xalign)

    {

      frame->label_xalign = xalign;

      g_object_notify (G_OBJECT (frame), "label-xalign");

    }

  if (yalign != frame->label_yalign)

    {

      frame->label_yalign = yalign;

      g_object_notify (G_OBJECT (frame), "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

 *     frame's label, or %NULL

 * @yalign: (out) (allow-none): location to store X alignment of

 *     frame's label, or %NULL

 * 

 * Retrieves the X and Y alignment of the frame's label. See

 * gtk_frame_set_label_align().

 **/

void

gtk_frame_get_label_align (GtkFrame *frame,

		           gfloat   *xalign,

			   gfloat   *yalign)

{

  g_return_if_fail (GTK_IS_FRAME (frame));

  if (xalign)

    *xalign = frame->label_xalign;

  if (yalign)

    *yalign = frame->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)

{

  GtkWidget *widget;

  g_return_if_fail (GTK_IS_FRAME (frame));

  if ((GtkShadowType) frame->shadow_type != type)

    {

      widget = GTK_WIDGET (frame);

      frame->shadow_type = type;

      g_object_notify (G_OBJECT (frame), "shadow-type");

      if (gtk_widget_is_drawable (widget))

	{

	  gtk_widget_queue_draw (widget);

	}

      gtk_widget_queue_resize (widget);

    }

}

/**

 * gtk_frame_get_shadow_type:

 * @frame: a #GtkFrame

 *

 * Retrieves the shadow type of the frame. See

 * gtk_frame_set_shadow_type().

 *

 * Return value: 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->shadow_type;

}

static void

gtk_frame_paint (GtkWidget    *widget,

		 GdkRectangle *area)

{

  GtkFrame *frame;

  gint x, y, width, height;

  if (gtk_widget_is_drawable (widget))

    {

      frame = GTK_FRAME (widget);

      x = frame->child_allocation.x - widget->style->xthickness;

      y = frame->child_allocation.y - widget->style->ythickness;

      width = frame->child_allocation.width + 2 * widget->style->xthickness;

      height =  frame->child_allocation.height + 2 * widget->style->ythickness;

      if (frame->label_widget)

	{

	  GtkRequisition child_requisition;

	  gfloat xalign;

	  gint height_extra;

	  gint x2;

	  gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);

	  if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)

	    xalign = frame->label_xalign;

	  else

	    xalign = 1 - frame->label_xalign;

	  height_extra = MAX (0, child_requisition.height - widget->style->ythickness)

	    - frame->label_yalign * child_requisition.height;

	  y -= height_extra;

	  height += height_extra;

	  x2 = widget->style->xthickness + (frame->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_SIDE_PAD;

	  /* If the label is completely over or under the frame we can omit the gap */

	  if (frame->label_yalign == 0.0 || frame->label_yalign == 1.0)

	    gtk_paint_shadow (widget->style, widget->window,

			      widget->state, frame->shadow_type,

			      area, widget, "frame",

			      x, y, width, height);

	  else

	    gtk_paint_shadow_gap (widget->style, widget->window,

				  widget->state, frame->shadow_type,

				  area, widget, "frame",

				  x, y, width, height,

				  GTK_POS_TOP,

				  x2, child_requisition.width + 2 * LABEL_PAD);

	}

       else

	 gtk_paint_shadow (widget->style, widget->window,

			   widget->state, frame->shadow_type,

			   area, widget, "frame",

			   x, y, width, height);

    }

}

static gboolean

gtk_frame_expose (GtkWidget      *widget,

		  GdkEventExpose *event)

{

  if (gtk_widget_is_drawable (widget))

    {

      gtk_frame_paint (widget, &event->area);

      GTK_WIDGET_CLASS (gtk_frame_parent_class)->expose_event (widget, event);

    }

  return FALSE;

}

static void

gtk_frame_size_request (GtkWidget      *widget,

			GtkRequisition *requisition)

{

  GtkFrame *frame = GTK_FRAME (widget);

  GtkBin *bin = GTK_BIN (widget);

  GtkRequisition child_requisition;

  if (frame->label_widget && gtk_widget_get_visible (frame->label_widget))

    {

      gtk_widget_size_request (frame->label_widget, &child_requisition);

      requisition->width = child_requisition.width + 2 * LABEL_PAD + 2 * LABEL_SIDE_PAD;

      requisition->height =

	MAX (0, child_requisition.height - widget->style->ythickness);

    }

  else

    {

      requisition->width = 0;

      requisition->height = 0;

    }

  if (bin->child && gtk_widget_get_visible (bin->child))

    {

      gtk_widget_size_request (bin->child, &child_requisition);

      requisition->width = MAX (requisition->width, child_requisition.width);

      requisition->height += child_requisition.height;

    }

  requisition->width += (GTK_CONTAINER (widget)->border_width +

			 GTK_WIDGET (widget)->style->xthickness) * 2;

  requisition->height += (GTK_CONTAINER (widget)->border_width +

			  GTK_WIDGET (widget)->style->ythickness) * 2;

}

static void

gtk_frame_size_allocate (GtkWidget     *widget,

			 GtkAllocation *allocation)

{

  GtkFrame *frame = GTK_FRAME (widget);

  GtkBin *bin = GTK_BIN (widget);

  GtkAllocation new_allocation;

  widget->allocation = *allocation;

  gtk_frame_compute_child_allocation (frame, &new_allocation);

  /* If the child allocation changed, that means that the frame is drawn

   * in a new place, so we must redraw the entire widget.

   */

  if (gtk_widget_get_mapped (widget) &&

      (new_allocation.x != frame->child_allocation.x ||

       new_allocation.y != frame->child_allocation.y ||

       new_allocation.width != frame->child_allocation.width ||

       new_allocation.height != frame->child_allocation.height))

    gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);

  if (bin->child && gtk_widget_get_visible (bin->child))

    gtk_widget_size_allocate (bin->child, &new_allocation);

  frame->child_allocation = new_allocation;

  if (frame->label_widget && gtk_widget_get_visible (frame->label_widget))

    {

      GtkRequisition child_requisition;

      GtkAllocation child_allocation;

      gfloat xalign;

      gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);

      if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)

	xalign = frame->label_xalign;

      else

	xalign = 1 - frame->label_xalign;

      child_allocation.x = frame->child_allocation.x + LABEL_SIDE_PAD +

	(frame->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_PAD;

      child_allocation.width = MIN (child_requisition.width, new_allocation.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD);

      child_allocation.y = frame->child_allocation.y - MAX (child_requisition.height, widget->style->ythickness);

      child_allocation.height = child_requisition.height;

      gtk_widget_size_allocate (frame->label_widget, &child_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)

{

  GtkWidget *widget = GTK_WIDGET (frame);

  GtkAllocation *allocation = &widget->allocation;

  GtkRequisition child_requisition;

  gint top_margin;

  if (frame->label_widget)

    {

      gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);

      top_margin = MAX (child_requisition.height, widget->style->ythickness);

    }

  else

    top_margin = widget->style->ythickness;

  child_allocation->x = (GTK_CONTAINER (frame)->border_width +

			 widget->style->xthickness);

  child_allocation->width = MAX(1, (gint)allocation->width - child_allocation->x * 2);

  child_allocation->y = (GTK_CONTAINER (frame)->border_width + top_margin);

  child_allocation->height = MAX (1, ((gint)allocation->height - child_allocation->y -

				      (gint)GTK_CONTAINER (frame)->border_width -

				      (gint)widget->style->ythickness));

  child_allocation->x += allocation->x;

  child_allocation->y += allocation->y;

}

#define __GTK_FRAME_C__

#include "gtkaliasdef.c"