source: trunk/third/gtk/gtk/gtkpacker.h @ 14482

/* GTK - The GIMP Toolkit 
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald 
 * 
 * GtkPacker Widget 
 * Copyright (C) 1998 Shawn T. Amundson, James S. Mitchell, Michael L. Staiger
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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-1999.  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/. 
 */

#ifndef __GTK_PACKER_H__
#define __GTK_PACKER_H__

#include <gtk/gtkcontainer.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


#define GTK_TYPE_PACKER            (gtk_packer_get_type ())
#define GTK_PACKER(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_PACKER, GtkPacker))
#define GTK_PACKER_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_PACKER, GtkPackerClass))
#define GTK_IS_PACKER(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_PACKER))
#define GTK_IS_PACKER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PACKER))



typedef struct _GtkPacker           GtkPacker;
typedef struct _GtkPackerClass      GtkPackerClass;
typedef struct _GtkPackerChild      GtkPackerChild;

typedef enum
{
    GTK_PACK_EXPAND   = 1 << 0, /*< nick=expand >*/
    GTK_FILL_X        = 1 << 1,
    GTK_FILL_Y        = 1 << 2
} GtkPackerOptions;

typedef enum
{
    GTK_SIDE_TOP,
    GTK_SIDE_BOTTOM,
    GTK_SIDE_LEFT,
    GTK_SIDE_RIGHT
} GtkSideType;

typedef enum
{
  GTK_ANCHOR_CENTER,
  GTK_ANCHOR_NORTH,
  GTK_ANCHOR_NORTH_WEST,
  GTK_ANCHOR_NORTH_EAST,
  GTK_ANCHOR_SOUTH,
  GTK_ANCHOR_SOUTH_WEST,
  GTK_ANCHOR_SOUTH_EAST,
  GTK_ANCHOR_WEST,
  GTK_ANCHOR_EAST,
  GTK_ANCHOR_N  =       GTK_ANCHOR_NORTH,
  GTK_ANCHOR_NW =       GTK_ANCHOR_NORTH_WEST,
  GTK_ANCHOR_NE =       GTK_ANCHOR_NORTH_EAST,
  GTK_ANCHOR_S  =       GTK_ANCHOR_SOUTH,
  GTK_ANCHOR_SW =       GTK_ANCHOR_SOUTH_WEST,
  GTK_ANCHOR_SE =       GTK_ANCHOR_SOUTH_EAST,
  GTK_ANCHOR_W  =       GTK_ANCHOR_WEST,
  GTK_ANCHOR_E  =       GTK_ANCHOR_EAST
} GtkAnchorType;

struct _GtkPackerChild
{
  GtkWidget *widget;
  
  GtkAnchorType anchor;
  GtkSideType side;
  GtkPackerOptions options;
  
  guint use_default : 1;
  
  guint border_width : 16;
  guint pad_x : 16;
  guint pad_y : 16;
  guint i_pad_x : 16;
  guint i_pad_y : 16;
};

struct _GtkPacker
{
  GtkContainer parent;
  
  GList *children;
  
  guint spacing;
  
  guint default_border_width : 16;
  guint default_pad_x : 16;
  guint default_pad_y : 16;
  guint default_i_pad_x : 16;
  guint default_i_pad_y : 16;
};

struct _GtkPackerClass
{
  GtkContainerClass parent_class;
};


GtkType    gtk_packer_get_type                 (void);
GtkWidget* gtk_packer_new                      (void);
void       gtk_packer_add_defaults             (GtkPacker       *packer, 
                                                GtkWidget       *child,
                                                GtkSideType      side,
                                                GtkAnchorType    anchor,
                                                GtkPackerOptions options);
void       gtk_packer_add                      (GtkPacker       *packer, 
                                                GtkWidget       *child,
                                                GtkSideType      side,
                                                GtkAnchorType    anchor,
                                                GtkPackerOptions options,
                                                guint            border_width, 
                                                guint            pad_x, 
                                                guint            pad_y,
                                                guint            i_pad_x,
                                                guint            i_pad_y);
void       gtk_packer_set_child_packing        (GtkPacker       *packer, 
                                                GtkWidget       *child,
                                                GtkSideType      side,
                                                GtkAnchorType    anchor,
                                                GtkPackerOptions options,
                                                guint            border_width, 
                                                guint            pad_x, 
                                                guint            pad_y,
                                                guint            i_pad_x,
                                                guint            i_pad_y);
void       gtk_packer_reorder_child            (GtkPacker       *packer,
                                                GtkWidget       *child,
                                                gint             position);
void       gtk_packer_set_spacing              (GtkPacker       *packer,
                                                guint            spacing);
void       gtk_packer_set_default_border_width (GtkPacker       *packer,
                                                guint            border);
void       gtk_packer_set_default_pad          (GtkPacker       *packer,
                                                guint             pad_x,
                                                guint             pad_y);
void       gtk_packer_set_default_ipad         (GtkPacker       *packer,
                                                guint            i_pad_x,
                                                guint            i_pad_y);


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_PACKER_H__ */