2
// Generated by gtkmmproc -- DO NOT MODIFY!
3
#ifndef _GTKMM_EVENTBOX_H
4
#define _GTKMM_EVENTBOX_H
9
/* $Id: eventbox.hg,v 1.2 2003/10/12 09:38:11 murrayc Exp $ */
13
* Copyright (C) 1998-2002 The gtkmm Development Team
15
* This library is free software; you can redistribute it and/or
16
* modify it under the terms of the GNU Lesser General Public
17
* License as published by the Free Software Foundation; either
18
* version 2.1 of the License, or (at your option) any later version.
20
* This library is distributed in the hope that it will be useful,
21
* but WITHOUT ANY WARRANTY; without even the implied warranty of
22
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23
* Lesser General Public License for more details.
25
* You should have received a copy of the GNU Lesser General Public
26
* License along with this library; if not, write to the Free
27
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30
#include <gtkmm/bin.h>
33
#ifndef DOXYGEN_SHOULD_SKIP_THIS
34
typedef struct _GtkEventBox GtkEventBox;
35
typedef struct _GtkEventBoxClass GtkEventBoxClass;
36
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
40
{ class EventBox_Class; } // namespace Gtk
44
/** Event capturing box.
46
* This widget adds an X Window where one does not
47
* normally appear, allowing you to capture events.
48
* It will receive any event which is specified
51
* This widget is generally used to add Gtk::Tooltips, button presses,
52
* and clipping to widgets derived from Gtk::Misc.
57
class EventBox : public Bin
60
#ifndef DOXYGEN_SHOULD_SKIP_THIS
61
typedef EventBox CppObjectType;
62
typedef EventBox_Class CppClassType;
63
typedef GtkEventBox BaseObjectType;
64
typedef GtkEventBoxClass BaseClassType;
65
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
69
#ifndef DOXYGEN_SHOULD_SKIP_THIS
72
friend class EventBox_Class;
73
static CppClassType eventbox_class_;
76
EventBox(const EventBox&);
77
EventBox& operator=(const EventBox&);
80
explicit EventBox(const Glib::ConstructParams& construct_params);
81
explicit EventBox(GtkEventBox* castitem);
83
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
86
#ifndef DOXYGEN_SHOULD_SKIP_THIS
87
static GType get_type() G_GNUC_CONST;
90
static GType get_base_type() G_GNUC_CONST;
93
///Provides access to the underlying C GtkObject.
94
GtkEventBox* gobj() { return reinterpret_cast<GtkEventBox*>(gobject_); }
96
///Provides access to the underlying C GtkObject.
97
const GtkEventBox* gobj() const { return reinterpret_cast<GtkEventBox*>(gobject_); }
101
//C++ methods used to invoke GTK+ virtual functions:
104
//GTK+ Virtual Functions (override these to change behaviour):
106
//Default Signal Handlers::
115
/** Returns whether the event box has a visible window.
116
* See set_visible_window() for details.
119
* @return <tt>true</tt> if the event box window is visible.
121
bool get_visible_window() const;
123
/** Set whether the event box uses a visible or invisible child
124
* window. The default is to use visible windows.
126
* In an invisible window event box, the window that the
127
* event box creates is a Gdk::INPUT_ONLY window, which
128
* means that it is invisible and only serves to receive
131
* A visible window event box creates a visible (Gdk::INPUT_OUTPUT)
132
* window that acts as the parent window for all the widgets
133
* contained in the event box.
135
* You should generally make your event box invisible if
136
* you just want to trap events. Creating a visible window
137
* may cause artifacts that are visible to the user, especially
138
* if the user is using a theme with gradients or pixmaps.
140
* The main reason to create a non input-only event box is if
141
* you want to set the background to a different color or
145
* There is one unexpected issue for an invisible event box that has its
146
* window below the child. (See set_above_child().)
147
* Since the input-only window is not an ancestor window of any windows
148
* that descendent widgets of the event box create, events on these
149
* windows aren't propagated up by the windowing system, but only by GTK+.
150
* The practical effect of this is if an event isn't in the event
151
* mask for the descendant window (see Gtk::Widget::add_events()),
152
* it won't be received by the event box.
154
* This problem doesn't occur for visible event boxes, because in
155
* that case, the event box window is actually the ancestor of the
156
* descendant windows, not just at the same place on the screen.
160
* @param visible_window Boolean value.
162
void set_visible_window(bool visible_window = true);
164
/** Returns whether the event box window is above or below the
165
* windows of its child. See set_above_child() for
169
* @return <tt>true</tt> if the event box window is above the window
172
bool get_above_child() const;
174
/** Set whether the event box window is positioned above the windows of its child,
175
* as opposed to below it. If the window is above, all events inside the
176
* event box will go to the event box. If the window is below, events
177
* in windows of child widgets will first got to that widget, and then
180
* The default is to keep the window below the child.
183
* @param above_child <tt>true</tt> if the event box window is above the windows of its child.
185
void set_above_child(bool above_child = true);
187
#ifdef GLIBMM_PROPERTIES_ENABLED
188
/** Whether the event box is visible, as opposed to invisible and only used to trap events.
190
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
191
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
192
* the value of the property changes.
194
Glib::PropertyProxy<bool> property_visible_window() ;
195
#endif //#GLIBMM_PROPERTIES_ENABLED
197
#ifdef GLIBMM_PROPERTIES_ENABLED
198
/** Whether the event box is visible, as opposed to invisible and only used to trap events.
200
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
201
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
202
* the value of the property changes.
204
Glib::PropertyProxy_ReadOnly<bool> property_visible_window() const;
205
#endif //#GLIBMM_PROPERTIES_ENABLED
207
#ifdef GLIBMM_PROPERTIES_ENABLED
208
/** Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.
210
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
211
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
212
* the value of the property changes.
214
Glib::PropertyProxy<bool> property_above_child() ;
215
#endif //#GLIBMM_PROPERTIES_ENABLED
217
#ifdef GLIBMM_PROPERTIES_ENABLED
218
/** Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it.
220
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
221
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
222
* the value of the property changes.
224
Glib::PropertyProxy_ReadOnly<bool> property_above_child() const;
225
#endif //#GLIBMM_PROPERTIES_ENABLED
230
} /* namespace Gtk */
235
/** A Glib::wrap() method for this object.
237
* @param object The C instance.
238
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
239
* @result A C++ instance that wraps this C instance.
241
* @relates Gtk::EventBox
243
Gtk::EventBox* wrap(GtkEventBox* object, bool take_copy = false);
247
#endif /* _GTKMM_EVENTBOX_H */
added
removed
include/gtkmm-2.4/gtkmm/eventbox.h
