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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_TOOLTIP_H
#define _GTKMM_TOOLTIP_H
#include <glibmm.h>
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <gdkmm/pixbuf.h>
#include <gtkmm/enums.h>
#include <gtkmm/widget.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTooltip GtkTooltip;
typedef struct _GtkTooltipClass GtkTooltipClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class Tooltip_Class; } // namespace Gtk
namespace Gtk
{
/** Add tips to your widgets
*
* Gtk::Tooltip belongs to the new tooltips API that was introduced in GTK+ 2.12
* and which deprecates the old Gtk::Tooltips API.
*
* Basic tooltips can be realized simply by using set_tooltip_text()
* or set_tooltip_markup() without any explicit tooltip object.
*
* When you need a tooltip with a little more fancy contents, like
* adding an image, or you want the tooltip to have different contents
* per Gtk::TreeView row or cell, you will have to do a little more work:
*
* - Call Gtk::Widget:set_has_tooltip(); this will
* make GTK+ monitor the widget for motion and related events
* which are needed to determine when and where to show a tooltip.
*
* - Connect to Gtk::Widget::signal_query_tooltip(). This signal
* will be emitted when a tooltip is supposed to be shown. One
* of the arguments passed to the signal handler is a Gtk::Tooltip
* object. This is the object that we are about to display as a
* tooltip, and can be manipulated in your callback using functions
* like Gtk::Tooltip::set_icon(). There are functions for setting
* the tooltip's markup, setting an image from a stock icon, or
* even putting in a custom widget.
*
* - Return true from your query-tooltip handler. This causes
* the tooltip to be show. If you return false, it will not be shown.
*
* In the probably rare case where you want to have even more control
* over the tooltip that is about to be shown, you can set your own
* Window which will be used as tooltip window. This works as follows:
*
* - Do Gtk::Widget::set_has_tooltip() and connect to
* Gtk::Widget::signal_query_tooltip() as before.
*
* - Use Gtk::Widget::set_tooltip_window() to set a Gtk::Window created
* by you as tooltip window.
*
* - In the query-tooltip callback you can access your window
* using Gtk::Widget::get_tooltip_window() and manipulate it as you
* wish. The semantics of the return value are exactly as before,
* return true to show the window, false to not show it.
*
* @newin2p12
*/
class Tooltip : public Glib::Object
{
protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Tooltip CppObjectType;
typedef Tooltip_Class CppClassType;
typedef GtkTooltip BaseObjectType;
typedef GtkTooltipClass BaseClassType;
private: friend class Tooltip_Class;
static CppClassType tooltip_class_;
private:
// noncopyable
Tooltip(const Tooltip&);
Tooltip& operator=(const Tooltip&);
protected:
explicit Tooltip(const Glib::ConstructParams& construct_params);
explicit Tooltip(GtkTooltip* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Tooltip();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkTooltip* gobj() { return reinterpret_cast<GtkTooltip*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkTooltip* gobj() const { return reinterpret_cast<GtkTooltip*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkTooltip* gobj_copy();
private:
public:
/** Sets the text of the tooltip to be @a markup , which is marked up
* with the Pango text markup language.
* If @a markup is <tt>0</tt>, the label will be hidden.
*
* @newin2p12
* @param markup A markup string (see Pango markup format) or <tt>0</tt>.
*/
void set_markup(const Glib::ustring& markup);
/** Sets the text of the tooltip to be @a text . If @a text is <tt>0</tt>, the label
* will be hidden. See also gtk_tooltip_set_markup().
*
* @newin2p12
* @param text A text string or <tt>0</tt>.
*/
void set_text(const Glib::ustring& markup);
/** Sets the icon of the tooltip (which is in front of the text) to be
* @a pixbuf . If @a pixbuf is <tt>0</tt>, the image will be hidden.
*
* @newin2p12
* @param pixbuf A Gdk::Pixbuf, or <tt>0</tt>.
*/
void set_icon(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
/** Sets the icon of the tooltip (which is in front of the text) to be
* the stock item indicated by @a stock_id with the size indicated
* by @a size . If @a stock_id is <tt>0</tt>, the image will be hidden.
*
* @newin2p12
* @param stock_id A stock icon name, or <tt>0</tt>.
* @param size A stock icon size.
*/
void set_icon_from_stock(const StockID& stock_id, IconSize size);
/** Replaces the widget packed into the tooltip with @a custom_widget .
* By default a box with a Gtk::Image and Gtk::Label is embedded in
* the tooltip, which can be configured using gtk_tooltip_set_markup()
* and gtk_tooltip_set_icon().
*
* @newin2p12
* @param custom_widget A Gtk::Widget.
*/
void set_custom(Widget& custom_widget);
/** Sets the area of the widget, where the contents of this tooltip apply,
* to be @a rect (in widget coordinates). This is especially useful for
* properly setting tooltips on Gtk::TreeView rows and cells, Gtk::IconViews,
* etc.
*
* For setting tooltips on Gtk::TreeView, please refer to the convenience
* functions for this: Gtk::TreeView::set_tooltip_row() and
* Gtk::TreeView::set_tooltip_cell().
*
* @newin2p12
* @param rect A Gdk::Rectangle.
*/
void set_tip_area(const Gdk::Rectangle& rect);
static void trigger_tooltip_query(const Glib::RefPtr<Gdk::Display>& display);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
protected:
//GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
//Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::Tooltip
*/
Glib::RefPtr<Gtk::Tooltip> wrap(GtkTooltip* object, bool take_copy = false);
}
#endif /* _GTKMM_TOOLTIP_H */
|
