/*
 * ctkoverlay.h
 * This file is part of ctk
 *
 * Copyright (C) 2011 - Ignacio Casal Quinteiro
 *
 * 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/>.
 */

#ifndef __CTK_OVERLAY_H__
#define __CTK_OVERLAY_H__

#if !defined (__CTK_H_INSIDE__) && !defined (CTK_COMPILATION)
#error "Only <ctk/ctk.h> can be included directly."
#endif

#include <ctk/ctkbin.h>

G_BEGIN_DECLS

#define CTK_TYPE_OVERLAY             (ctk_overlay_get_type ())
#define CTK_OVERLAY(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), CTK_TYPE_OVERLAY, CtkOverlay))
#define CTK_OVERLAY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), CTK_TYPE_OVERLAY, CtkOverlayClass))
#define CTK_IS_OVERLAY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CTK_TYPE_OVERLAY))
#define CTK_IS_OVERLAY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), CTK_TYPE_OVERLAY))
#define CTK_OVERLAY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), CTK_TYPE_OVERLAY, CtkOverlayClass))

typedef struct _CtkOverlay         CtkOverlay;
typedef struct _CtkOverlayClass    CtkOverlayClass;
typedef struct _CtkOverlayPrivate  CtkOverlayPrivate;

struct _CtkOverlay
{
  CtkBin parent;

  CtkOverlayPrivate *priv;
};

/**
 * CtkOverlayClass:
 * @parent_class: The parent class.
 * @get_child_position: Signal emitted to determine the position and
 *    size of any overlay child widgets.
 */
struct _CtkOverlayClass
{
  CtkBinClass parent_class;

  /*< public >*/

  gboolean (*get_child_position) (CtkOverlay    *overlay,
                                  CtkWidget     *widget,
                                  CtkAllocation *allocation);

  /*< private >*/

  /* Padding for future expansion */
  void (*_ctk_reserved1) (void);
  void (*_ctk_reserved2) (void);
  void (*_ctk_reserved3) (void);
  void (*_ctk_reserved4) (void);
  void (*_ctk_reserved5) (void);
  void (*_ctk_reserved6) (void);
  void (*_ctk_reserved7) (void);
  void (*_ctk_reserved8) (void);
};

CDK_AVAILABLE_IN_3_2
GType      ctk_overlay_get_type    (void) G_GNUC_CONST;
CDK_AVAILABLE_IN_3_2
CtkWidget *ctk_overlay_new         (void);
CDK_AVAILABLE_IN_3_2
void       ctk_overlay_add_overlay (CtkOverlay *overlay,
                                    CtkWidget  *widget);
CDK_AVAILABLE_IN_3_18
void       ctk_overlay_reorder_overlay (CtkOverlay *overlay,
                                        CtkWidget  *child,
                                        int         index_);
CDK_AVAILABLE_IN_3_18
gboolean   ctk_overlay_get_overlay_pass_through (CtkOverlay *overlay,
						 CtkWidget  *widget);
CDK_AVAILABLE_IN_3_18
void       ctk_overlay_set_overlay_pass_through (CtkOverlay *overlay,
						 CtkWidget  *widget,
						 gboolean    pass_through);

G_END_DECLS

#endif /* __CTK_OVERLAY_H__ */
