AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
3e836dd9fc
gtk2/gtk/gtkflowbox.h
Matthias Clasen 943d575ec3 Add GtkFlowBox 
GtkFlowBox is a container that its children in a reflowing
grid, which can be oriented horizontally or vertically.

It is similar to GtkListBox in that the children can
be sorted and filtered, and by requiring a dedicated child
widget type, GtkFlowBoxChild. It is similar to GtkTreeView
in that is supports a full set of selection modes, including
rubberband selection.

This is the culmination of work that has happened in the
egg-list-box module, and earlier in libegg. The origins of
this code are the EggSpreadTable in libegg, which was written
by Tristan van Berkom. It was moved to egg-list-box and
renamed EggFlowBox by Jon McCann, and I gave it some finishing
touched in the flowbox-improvements branch of that module.
2013-10-06 23:31:17 -04:00

221 lines
10 KiB
C
Raw Blame History

/*
* Copyright (C) 2010 Openismus GmbH
* Copyright (C) 2013 Red Hat, Inc.
*
* 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.
*
* Authors:
* Tristan Van Berkom <tristanvb@openismus.com>
* Matthias Clasen <mclasen@redhat.com>
* William Jon McCann <jmccann@redhat.com>
*/
#ifndef __GTK_FLOW_BOX_H__
#define __GTK_FLOW_BOX_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gtk/gtkbin.h>
G_BEGIN_DECLS
#define GTK_TYPE_FLOW_BOX (gtk_flow_box_get_type ())
#define GTK_FLOW_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FLOW_BOX, GtkFlowBox))
#define GTK_FLOW_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FLOW_BOX, GtkFlowBoxClass))
#define GTK_IS_FLOW_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FLOW_BOX))
#define GTK_IS_FLOW_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FLOW_BOX))
#define GTK_FLOW_BOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FLOW_BOX, GtkFlowBoxClass))
typedef struct _GtkFlowBox GtkFlowBox;
typedef struct _GtkFlowBoxClass GtkFlowBoxClass;
typedef struct _GtkFlowBoxChild GtkFlowBoxChild;
typedef struct _GtkFlowBoxChildClass GtkFlowBoxChildClass;
struct _GtkFlowBox
{
GtkContainer container;
};
struct _GtkFlowBoxClass
{
GtkContainerClass parent_class;
void (*child_activated) (GtkFlowBox *box,
GtkFlowBoxChild *child);
void (*selected_children_changed) (GtkFlowBox *box);
void (*activate_cursor_child) (GtkFlowBox *box);
void (*toggle_cursor_child) (GtkFlowBox *box);
void (*move_cursor) (GtkFlowBox *box,
GtkMovementStep step,
gint count);
void (*select_all) (GtkFlowBox *box);
void (*unselect_all) (GtkFlowBox *box);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
void (*_gtk_reserved5) (void);
void (*_gtk_reserved6) (void);
};
#define GTK_TYPE_FLOW_BOX_CHILD (gtk_flow_box_child_get_type ())
#define GTK_FLOW_BOX_CHILD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChild))
#define GTK_FLOW_BOX_CHILD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChildClass))
#define GTK_IS_FLOW_BOX_CHILD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FLOW_BOX_CHILD))
#define GTK_IS_FLOW_BOX_CHILD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FLOW_BOX_CHILD))
#define GTK_FLOW_BOX_CHILD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EG_TYPE_FLOW_BOX_CHILD, GtkFlowBoxChildClass))
struct _GtkFlowBoxChild
{
GtkBin parent_instance;
};
struct _GtkFlowBoxChildClass
{
GtkBinClass parent_class;
void (* activate) (GtkFlowBoxChild *child);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
};
GDK_AVAILABLE_IN_3_12
GType gtk_flow_box_child_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_3_12
GtkWidget* gtk_flow_box_child_new (void);
GDK_AVAILABLE_IN_3_12
gint gtk_flow_box_child_get_index (GtkFlowBoxChild *child);
GDK_AVAILABLE_IN_3_12
gboolean gtk_flow_box_child_is_selected (GtkFlowBoxChild *child);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_child_changed (GtkFlowBoxChild *child);
GDK_AVAILABLE_IN_3_12
GType gtk_flow_box_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_3_12
GtkWidget *gtk_flow_box_new (void);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_homogeneous (GtkFlowBox *box,
gboolean homogeneous);
GDK_AVAILABLE_IN_3_12
gboolean gtk_flow_box_get_homogeneous (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_row_spacing (GtkFlowBox *box,
guint spacing);
GDK_AVAILABLE_IN_3_12
guint gtk_flow_box_get_row_spacing (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_column_spacing (GtkFlowBox *box,
guint spacing);
GDK_AVAILABLE_IN_3_12
guint gtk_flow_box_get_column_spacing (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_min_children_per_line (GtkFlowBox *box,
guint n_children);
GDK_AVAILABLE_IN_3_12
guint gtk_flow_box_get_min_children_per_line (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_max_children_per_line (GtkFlowBox *box,
guint n_children);
GDK_AVAILABLE_IN_3_12
guint gtk_flow_box_get_max_children_per_line (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_activate_on_single_click (GtkFlowBox *box,
gboolean single);
GDK_AVAILABLE_IN_3_12
gboolean gtk_flow_box_get_activate_on_single_click (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_insert (GtkFlowBox *box,
GtkWidget *widget,
gint position);
GDK_AVAILABLE_IN_3_12
GtkFlowBoxChild *gtk_flow_box_get_child_at_index (GtkFlowBox *box,
gint idx);
typedef void (* GtkFlowBoxForeachFunc) (GtkFlowBox *box,
GtkFlowBoxChild *child,
gpointer user_data);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_selected_foreach (GtkFlowBox *box,
GtkFlowBoxForeachFunc func,
gpointer data);
GDK_AVAILABLE_IN_3_12
GList *gtk_flow_box_get_selected_children (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_select_child (GtkFlowBox *box,
GtkFlowBoxChild *child);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_unselect_child (GtkFlowBox *box,
GtkFlowBoxChild *child);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_select_all (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_unselect_all (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_selection_mode (GtkFlowBox *box,
GtkSelectionMode mode);
GDK_AVAILABLE_IN_3_12
GtkSelectionMode gtk_flow_box_get_selection_mode (GtkFlowBox *box);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_hadjustment (GtkFlowBox *box,
GtkAdjustment *adjustment);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_vadjustment (GtkFlowBox *box,
GtkAdjustment *adjustment);
typedef gboolean (*GtkFlowBoxFilterFunc) (GtkFlowBoxChild *child,
gpointer user_data);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_filter_func (GtkFlowBox *box,
GtkFlowBoxFilterFunc filter_func,
gpointer user_data,
GDestroyNotify destroy);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_invalidate_filter (GtkFlowBox *box);
typedef gint (*GtkFlowBoxSortFunc) (GtkFlowBoxChild *child1,
GtkFlowBoxChild *child2,
gpointer user_data);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_set_sort_func (GtkFlowBox *box,
GtkFlowBoxSortFunc sort_func,
gpointer user_data,
GDestroyNotify destroy);
GDK_AVAILABLE_IN_3_12
void gtk_flow_box_invalidate_sort (GtkFlowBox *box);
G_END_DECLS
#endif /* __GTK_FLOW_BOX_H__ */
Reference in New Issue View Git Blame Copy Permalink