2008-12-11 Claudio Saavedra <csaavedra@igalia.com>
[hildon] / src / hildon-window.h
1 /*
2  * This file is a part of hildon
3  *
4  * Copyright (C) 2006 Nokia Corporation, all rights reserved.
5  *
6  * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24
25 #ifndef                                         __HILDON_WINDOW_H__
26 #define                                         __HILDON_WINDOW_H__
27
28 #include                                        <gtk/gtk.h>
29
30 G_BEGIN_DECLS
31
32 #define                                         HILDON_WINDOW_LONG_PRESS_TIME 800 /* in ms */
33
34 #define                                         HILDON_TYPE_WINDOW \
35                                                 (hildon_window_get_type())
36
37 #define                                         HILDON_WINDOW(obj) \
38                                                 (GTK_CHECK_CAST (obj, HILDON_TYPE_WINDOW, HildonWindow))
39
40 #define                                         HILDON_WINDOW_CLASS(klass) \
41                                                 (GTK_CHECK_CLASS_CAST ((klass),\
42                                                 HILDON_TYPE_WINDOW, HildonWindowClass))
43
44 #define                                         HILDON_IS_WINDOW(obj) \
45                                                 (GTK_CHECK_TYPE (obj, HILDON_TYPE_WINDOW))
46
47 #define                                         HILDON_IS_WINDOW_CLASS(klass) \
48                                                 (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_WINDOW))
49
50 #define                                         HILDON_WINDOW_GET_CLASS(obj) \
51                                                 ((HildonWindowClass *) G_OBJECT_GET_CLASS(obj))
52
53 typedef struct                                  _HildonWindow HildonWindow;
54
55 typedef struct                                  _HildonWindowClass HildonWindowClass;
56
57 typedef enum
58 {
59     HILDON_WINDOW_CO_COPY,
60     HILDON_WINDOW_CO_CUT,
61     HILDON_WINDOW_CO_PASTE
62 }                                               HildonWindowClipboardOperation;
63
64 struct                                          _HildonWindow
65 {
66     GtkWindow parent;
67 };
68
69 struct                                          _HildonWindowClass
70 {
71     GtkWindowClass parent_class;
72
73     /* opera hacks for clip board operation */
74     void (*clipboard_operation)(HildonWindow *hwindow, int operation);
75     gboolean (*toggle_menu)(HildonWindow * self, guint button, guint32 time);
76     /* Padding for future extension */
77     void (*_hildon_reserved1)(void);
78     void (*_hildon_reserved2)(void);
79 };
80
81 GType G_GNUC_CONST
82 hildon_window_get_type                          (void);
83
84 GtkWidget*
85 hildon_window_new                               (void);
86
87 void        
88 hildon_window_add_with_scrollbar                (HildonWindow *self,
89                                                  GtkWidget    *child);
90
91 GtkMenu*    
92 hildon_window_get_menu                          (HildonWindow *self);
93
94 void
95 hildon_window_set_main_menu                     (HildonWindow *self,
96                                                  GtkMenu      *menu);
97
98 #ifndef HILDON_DISABLE_DEPRECATED
99 void        
100 hildon_window_set_menu                          (HildonWindow *self,
101                                                  GtkMenu      *menu);
102 #endif
103
104 void    
105 hildon_window_add_toolbar                       (HildonWindow *self,
106                                                  GtkToolbar   *toolbar);
107
108 void        
109 hildon_window_remove_toolbar                    (HildonWindow *self,
110                                                  GtkToolbar   *toolbar);
111
112 gboolean    
113 hildon_window_get_is_topmost                    (HildonWindow *self);
114
115 G_END_DECLS
116
117 #endif                                          /* __HILDON_WINDOW_H__ */