src/libgdl/gdl-dock-master.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * gdl-dock-master.h - Object which manages a dock ring
   4  *
   5  * This file is part of the GNOME Devtools Libraries.
   6  *
   7  * Copyright (C) 2002 Gustavo Giráldez <gustavo.giraldez@gmx.net>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  22  */
  23
  24 #ifndef __GDL_DOCK_MASTER_H__
  25 #define __GDL_DOCK_MASTER_H__
  26
  27 #include <glib-object.h>
  28 #include <gtk/gtktypeutils.h>
  29 #include "libgdl/gdl-dock-object.h"
  30
  31
  32 G_BEGIN_DECLS
  33
  34 /* standard macros */
  35 #define GDL_TYPE_DOCK_MASTER             (gdl_dock_master_get_type ())
  36 #define GDL_DOCK_MASTER(obj)             (GTK_CHECK_CAST ((obj), GDL_TYPE_DOCK_MASTER, GdlDockMaster))
  37 #define GDL_DOCK_MASTER_CLASS(klass)     (GTK_CHECK_CLASS_CAST ((klass), GDL_TYPE_DOCK_MASTER, GdlDockMasterClass))
  38 #define GDL_IS_DOCK_MASTER(obj)          (GTK_CHECK_TYPE ((obj), GDL_TYPE_DOCK_MASTER))
  39 #define GDL_IS_DOCK_MASTER_CLASS(klass)  (GTK_CHECK_CLASS_TYPE ((klass), GDL_TYPE_DOCK_MASTER))
  40 #define GDL_DOCK_MASTER_GET_CLASS(obj)   (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_DOCK_MASTER, GdlDockMasterClass))
  41
  42 /* data types & structures */
  43 typedef struct _GdlDockMaster        GdlDockMaster;
  44 typedef struct _GdlDockMasterClass   GdlDockMasterClass;
  45 typedef struct _GdlDockMasterPrivate GdlDockMasterPrivate;
  46
  47 struct _GdlDockMaster {
  48     GObject               object;
  49
  50     GHashTable           *dock_objects;
  51     GList                *toplevel_docks;
  52     GdlDockObject        *controller;      /* GUI root object */
  53
  54     gint                  dock_number;     /* for toplevel dock numbering */
  55
  56     GdlDockMasterPrivate *_priv;
  57 };
  58
  59 struct _GdlDockMasterClass {
  60     GObjectClass parent_class;
  61
  62     void (* layout_changed) (GdlDockMaster *master);
  63 };
  64
  65 /* additional macros */
  66
  67 #define GDL_DOCK_OBJECT_GET_MASTER(object) \
  68     (GDL_DOCK_OBJECT (object)->master ? \
  69         GDL_DOCK_MASTER (GDL_DOCK_OBJECT (object)->master) : NULL)
  70
  71 /* public interface */
  72
  73 GType          gdl_dock_master_get_type         (void);
  74
  75 void           gdl_dock_master_add              (GdlDockMaster *master,
  76                                                  GdlDockObject *object);
  77 void           gdl_dock_master_remove           (GdlDockMaster *master,
  78                                                  GdlDockObject *object);
  79 void           gdl_dock_master_foreach          (GdlDockMaster *master,
  80                                                  GFunc          function,
  81                                                  gpointer       user_data);
  82
  83 void           gdl_dock_master_foreach_toplevel (GdlDockMaster *master,
  84                                                  gboolean       include_controller,
  85                                                  GFunc          function,
  86                                                  gpointer       user_data);
  87
  88 GdlDockObject *gdl_dock_master_get_object       (GdlDockMaster *master,
  89                                                  const gchar   *nick_name);
  90
  91 GdlDockObject *gdl_dock_master_get_controller   (GdlDockMaster *master);
  92 void           gdl_dock_master_set_controller   (GdlDockMaster *master,
  93                                                  GdlDockObject *new_controller);
  94
  95 G_END_DECLS
  96
  97 #endif /* __GDL_DOCK_MASTER_H__ */