summaryrefslogtreecommitdiff
path: root/gtk/gtkplugprivate.h
blob: fb173c13408eef9ace8b7a5a960139656f9fc0f3 (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
131
132
133
134
135
136
137
138
139
140
141
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  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_PLUG_PRIVATE_H__
#define __GTK_PLUG_PRIVATE_H__

/* In gtkplug.c: */
void _gtk_plug_send_delete_event      (GtkWidget        *widget);
void _gtk_plug_add_all_grabbed_keys   (GtkPlug          *plug);
void _gtk_plug_focus_first_last       (GtkPlug          *plug,
				       GtkDirectionType  direction);
void _gtk_plug_handle_modality_on     (GtkPlug          *plug);
void _gtk_plug_handle_modality_off    (GtkPlug          *plug);

/* In backend-specific file: */

/**
 * _gtk_plug_windowing_get_id:
 *
 * @plug: a #GtkPlug
 *
 * Returns the native window system identifier for the plug's window.
 */
GdkNativeWindow _gtk_plug_windowing_get_id (GtkPlug *plug);

/**
 * _gtk_plug_windowing_realize_toplevel:
 *
 * @plug_window: a #GtkPlug's #GdkWindow
 *
 * Called from GtkPlug's realize method. Should tell the corresponding
 * socket that the plug has been realized.
 */
void _gtk_plug_windowing_realize_toplevel (GtkPlug *plug);

/**
 * _gtk_plug_windowing_map_toplevel:
 *
 * @plug: a #GtkPlug
 *
 * Called from GtkPlug's map method. Should tell the corresponding
 * #GtkSocket that the plug has been mapped.
 */
void _gtk_plug_windowing_map_toplevel (GtkPlug *plug);

/**
 * _gtk_plug_windowing_map_toplevel:
 *
 * @plug: a #GtkPlug
 *
 * Called from GtkPlug's unmap method. Should tell the corresponding
 * #GtkSocket that the plug has been unmapped.
 */
void _gtk_plug_windowing_unmap_toplevel (GtkPlug *plug);

/**
 * _gtk_plug_windowing_set_focus:
 *
 * @plug: a #GtkPlug
 *
 * Called from GtkPlug's set_focus method. Should tell the corresponding
 * #GtkSocket to request focus.
 */
void _gtk_plug_windowing_set_focus (GtkPlug *plug);

/**
 * _gtk_plug_windowing_add_grabbed_key:
 *
 * @plug: a #GtkPlug
 * @accelerator_key: a key
 * @accelerator_mods: modifiers for it
 *
 * Called from GtkPlug's keys_changed method. Should tell the
 * corresponding #GtkSocket to grab the key.
 */
void _gtk_plug_windowing_add_grabbed_key (GtkPlug         *plug,
					  guint            accelerator_key,
					  GdkModifierType  accelerator_mods);

/**
 * _gtk_plug_windowing_remove_grabbed_key:
 *
 * @plug: a #GtkPlug
 * @accelerator_key: a key
 * @accelerator_mods: modifiers for it
 *
 * Called from GtkPlug's keys_changed method. Should tell the
 * corresponding #GtkSocket to remove the key grab.
 */
void _gtk_plug_windowing_remove_grabbed_key (GtkPlug         *plug,
					     guint            accelerator_key,
					     GdkModifierType  accelerator_mods);

/**
 * _gtk_plug_windowing_focus_to_parent:
 *
 * @plug: a #GtkPlug
 * @direction: a direction
 *
 * Called from GtkPlug's focus method. Should tell the corresponding
 * #GtkSocket to move the focus.
 */
void _gtk_plug_windowing_focus_to_parent (GtkPlug         *plug,
					  GtkDirectionType direction);

/**
 * _gtk_plug_windowing_filter_func:
 *
 * @gdk_xevent: a windowing system native event
 * @event: a pre-allocated empty GdkEvent
 * @data: the #GtkPlug
 *
 * Event filter function installed on plug windows.
 */
GdkFilterReturn _gtk_plug_windowing_filter_func (GdkXEvent *gdk_xevent,
						 GdkEvent  *event,
						 gpointer   data);

#endif /* __GTK_PLUG_PRIVATE_H__ */