8dec729a1ceab81e2aac7d4501dadd747e8de6f6
[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 #include                                        "hildon-app-menu.h"
30 #include                                        "hildon-edit-toolbar.h"
31
32 G_BEGIN_DECLS
33
34 #define                                         HILDON_WINDOW_LONG_PRESS_TIME 800 /* in ms */
35
36 #define                                         HILDON_TYPE_WINDOW \
37                                                 (hildon_window_get_type())
38
39 #define                                         HILDON_WINDOW(obj) \
40                                                 (GTK_CHECK_CAST (obj, HILDON_TYPE_WINDOW, HildonWindow))
41
42 #define                                         HILDON_WINDOW_CLASS(klass) \
43                                                 (GTK_CHECK_CLASS_CAST ((klass),\
44                                                 HILDON_TYPE_WINDOW, HildonWindowClass))
45
46 #define                                         HILDON_IS_WINDOW(obj) \
47                                                 (GTK_CHECK_TYPE (obj, HILDON_TYPE_WINDOW))
48
49 #define                                         HILDON_IS_WINDOW_CLASS(klass) \
50                                                 (GTK_CHECK_CLASS_TYPE ((klass), HILDON_TYPE_WINDOW))
51
52 #define                                         HILDON_WINDOW_GET_CLASS(obj) \
53                                                 ((HildonWindowClass *) G_OBJECT_GET_CLASS(obj))
54
55 typedef struct                                  _HildonWindow HildonWindow;
56
57 typedef struct                                  _HildonWindowClass HildonWindowClass;
58
59 typedef enum
60 {
61     HILDON_WINDOW_CO_COPY,
62     HILDON_WINDOW_CO_CUT,
63     HILDON_WINDOW_CO_PASTE
64 }                                               HildonWindowClipboardOperation;
65
66 struct                                          _HildonWindow
67 {
68     GtkWindow parent;
69 };
70
71 struct                                          _HildonWindowClass
72 {
73     GtkWindowClass parent_class;
74
75     /* opera hacks for clip board operation */
76     void (*clipboard_operation)(HildonWindow *hwindow, int operation);
77     gboolean (*toggle_menu)(HildonWindow * self, guint button, guint32 time);
78     /* Padding for future extension */
79     void (*_hildon_reserved1)(void);
80     void (*_hildon_reserved2)(void);
81 };
82
83 GType G_GNUC_CONST
84 hildon_window_get_type                          (void);
85
86 GtkWidget*
87 hildon_window_new                               (void);
88
89 void        
90 hildon_window_add_with_scrollbar                (HildonWindow *self,
91                                                  GtkWidget    *child);
92
93 void
94 hildon_window_set_main_menu                     (HildonWindow *self,
95                                                  GtkMenu      *menu);
96
97 GtkMenu*
98 hildon_window_get_main_menu                     (HildonWindow *self);
99
100 void
101 hildon_window_set_app_menu                      (HildonWindow  *self,
102                                                  HildonAppMenu *menu);
103
104 HildonAppMenu *
105 hildon_window_get_app_menu                      (HildonWindow *self);
106
107 #ifndef HILDON_DISABLE_DEPRECATED
108 void        
109 hildon_window_set_menu                          (HildonWindow *self,
110                                                  GtkMenu      *menu);
111
112 GtkMenu*
113 hildon_window_get_menu                          (HildonWindow *self);
114 #endif
115
116 void    
117 hildon_window_add_toolbar                       (HildonWindow *self,
118                                                  GtkToolbar   *toolbar);
119
120 void        
121 hildon_window_remove_toolbar                    (HildonWindow *self,
122                                                  GtkToolbar   *toolbar);
123
124 void
125 hildon_window_set_edit_toolbar                  (HildonWindow      *self,
126                                                  HildonEditToolbar *toolbar);
127
128 gboolean    
129 hildon_window_get_is_topmost                    (HildonWindow *self);
130
131 G_END_DECLS
132
133 #endif                                          /* __HILDON_WINDOW_H__ */