summaryrefslogtreecommitdiff
path: root/pluma/pluma-panel.h
blob: e697c175db69da9afb01456495460b55506854a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * pluma-panel.h
 * This file is part of pluma
 *
 * Copyright (C) 2005 - Paolo Maggi 
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, 
 * Boston, MA 02110-1301, USA.
 */
 
/*
 * Modified by the pluma Team, 2005. See the AUTHORS file for a 
 * list of people on the pluma Team.  
 * See the ChangeLog files for a list of changes. 
 *
 * $Id$
 */

#ifndef __PLUMA_PANEL_H__
#define __PLUMA_PANEL_H__

#include <gtk/gtk.h>

G_BEGIN_DECLS

/*
 * Type checking and casting macros
 */
#define PLUMA_TYPE_PANEL		(pluma_panel_get_type())
#define PLUMA_PANEL(obj)		(G_TYPE_CHECK_INSTANCE_CAST((obj), PLUMA_TYPE_PANEL, PlumaPanel))
#define PLUMA_PANEL_CLASS(klass)	(G_TYPE_CHECK_CLASS_CAST((klass), PLUMA_TYPE_PANEL, PlumaPanelClass))
#define PLUMA_IS_PANEL(obj)		(G_TYPE_CHECK_INSTANCE_TYPE((obj), PLUMA_TYPE_PANEL))
#define PLUMA_IS_PANEL_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), PLUMA_TYPE_PANEL))
#define PLUMA_PANEL_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS((obj), PLUMA_TYPE_PANEL, PlumaPanelClass))

/* Private structure type */
typedef struct _PlumaPanelPrivate PlumaPanelPrivate;

/*
 * Main object structure
 */
typedef struct _PlumaPanel PlumaPanel;

struct _PlumaPanel 
{
	GtkBox vbox;

	/*< private > */
	PlumaPanelPrivate *priv;
};

/*
 * Class definition
 */
typedef struct _PlumaPanelClass PlumaPanelClass;

struct _PlumaPanelClass 
{
	GtkBoxClass parent_class;

	void (* item_added)     (PlumaPanel     *panel,
				 GtkWidget      *item);
	void (* item_removed)   (PlumaPanel     *panel,
				 GtkWidget      *item);

	/* Keybinding signals */
	void (* close)          (PlumaPanel     *panel);
	void (* focus_document) (PlumaPanel     *panel);

	/* Padding for future expansion */
	void (*_pluma_reserved1) (void);
	void (*_pluma_reserved2) (void);
	void (*_pluma_reserved3) (void);
	void (*_pluma_reserved4) (void);	
};

/*
 * Public methods
 */
GType 		 pluma_panel_get_type 			(void) G_GNUC_CONST;

GtkWidget 	*pluma_panel_new 			(GtkOrientation	 orientation);

void		 pluma_panel_add_item			(PlumaPanel     *panel,
						      	 GtkWidget      *item,
						      	 const gchar    *name,
							 GtkWidget      *image);

void		 pluma_panel_add_item_with_icon	(PlumaPanel     *panel,
						 GtkWidget      *item,
						 const gchar    *name,
						 const gchar    *icon_name);

gboolean	 pluma_panel_remove_item	(PlumaPanel     *panel,
					  	 GtkWidget      *item);

gboolean	 pluma_panel_activate_item 	(PlumaPanel     *panel,
					    	 GtkWidget      *item);

gboolean	 pluma_panel_item_is_active 	(PlumaPanel     *panel,
					    	 GtkWidget      *item);

GtkOrientation	 pluma_panel_get_orientation	(PlumaPanel	*panel);

gint		 pluma_panel_get_n_items	(PlumaPanel	*panel);


/*
 * Non exported functions
 */
gint		 _pluma_panel_get_active_item_id	(PlumaPanel	*panel);

void		 _pluma_panel_set_active_item_by_id	(PlumaPanel	*panel,
							 gint		 id);

G_END_DECLS

#endif  /* __PLUMA_PANEL_H__  */