~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkDrawingArea.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
5
<title>GtkDrawingArea</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
7
<link rel="start" href="index.html" title="GTK+ Reference Manual">
 
8
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
 
9
<link rel="prev" href="GtkCalendar.html" title="GtkCalendar">
 
10
<link rel="next" href="GtkEventBox.html" title="GtkEventBox">
 
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="gtk.html" title="Part&#160;I.&#160;GTK+ Overview">
 
14
<link rel="part" href="gtkbase.html" title="Part&#160;II.&#160;GTK+ Core Reference">
 
15
<link rel="part" href="gtkobjects.html" title="Part&#160;III.&#160;GTK+ Widgets and Objects">
 
16
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
 
17
<link rel="chapter" href="ch02.html" title="Widget Gallery">
 
18
<link rel="chapter" href="WindowWidgets.html" title="Windows">
 
19
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
 
20
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
 
21
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
 
22
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
 
23
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
 
24
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
 
25
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
 
26
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
 
27
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
 
28
<link rel="chapter" href="Ornaments.html" title="Ornaments">
 
29
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
 
30
<link rel="chapter" href="Printing.html" title="Printing">
 
31
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
 
32
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
 
33
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
 
34
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
 
35
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
 
36
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
 
37
<link rel="part" href="migrating.html" title="Part&#160;IV.&#160;Migrating from Previous Versions of GTK+">
 
38
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
 
39
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
 
40
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
 
41
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
 
42
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
 
43
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
 
44
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
 
45
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
 
46
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
 
47
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
 
48
<link rel="part" href="pt05.html" title="Part&#160;V.&#160;GTK+ Tools">
 
49
<link rel="glossary" href="glossary.html" title="Glossary">
 
50
<link rel="index" href="ix01.html" title="Index">
 
51
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
 
52
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
 
53
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
 
54
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
 
55
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
 
56
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
 
57
</head>
 
58
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
59
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
60
<tr valign="middle">
 
61
<td><a accesskey="p" href="GtkCalendar.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
62
<td><a accesskey="u" href="MiscObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
63
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
64
<th width="100%" align="center">GTK+ Reference Manual</th>
 
65
<td><a accesskey="n" href="GtkEventBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
66
</tr>
 
67
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3664728" class="shortcut">Top</a>
 
68
                  &#160;|&#160;
 
69
                  <a href="#id3664882" class="shortcut">Description</a>
 
70
                  &#160;|&#160;
 
71
                  <a href="#id3664805" class="shortcut">Object Hierarchy</a>
 
72
                  &#160;|&#160;
 
73
                  <a href="#id3664859" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
 
74
</table>
 
75
<div class="refentry" lang="en">
 
76
<a name="GtkDrawingArea"></a><div class="titlepage"></div>
 
77
<div class="refnamediv"><table width="100%"><tr>
 
78
<td valign="top">
 
79
<h2>
 
80
<a name="id3664728"></a><span class="refentrytitle">GtkDrawingArea</span>
 
81
</h2>
 
82
<p>GtkDrawingArea &#8212; A widget for custom user interface elements</p>
 
83
</td>
 
84
<td valign="top" align="right"></td>
 
85
</tr></table></div>
 
86
<div class="refsynopsisdiv">
 
87
<h2>Synopsis</h2>
 
88
<pre class="synopsis">
 
89
 
 
90
#include &lt;gtk/gtk.h&gt;
 
91
 
 
92
 
 
93
                    <a href="GtkDrawingArea.html#GtkDrawingArea-struct">GtkDrawingArea</a>;
 
94
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>*          <a href="GtkDrawingArea.html#gtk-drawing-area-new">gtk_drawing_area_new</a>                (void);
 
95
void                <a href="GtkDrawingArea.html#gtk-drawing-area-size">gtk_drawing_area_size</a>               (<a href="GtkDrawingArea.html" title="GtkDrawingArea">GtkDrawingArea</a> *darea,
 
96
                                                         gint width,
 
97
                                                         gint height);
 
98
 
 
99
 
 
100
</pre>
 
101
</div>
 
102
<div class="refsect1" lang="en">
 
103
<a name="id3664805"></a><h2>Object Hierarchy</h2>
 
104
<pre class="synopsis">
 
105
 
 
106
  GObject
 
107
   +----GInitiallyUnowned
 
108
         +----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
 
109
               +----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
 
110
                     +----GtkDrawingArea
 
111
                           +----<a href="GtkCurve.html" title="GtkCurve">GtkCurve</a>
 
112
</pre>
 
113
</div>
 
114
<div class="refsect1" lang="en">
 
115
<a name="id3664859"></a><h2>Implemented Interfaces</h2>
 
116
<p>
 
117
GtkDrawingArea implements
 
118
 AtkImplementorIface.</p>
 
119
</div>
 
120
<div class="refsect1" lang="en">
 
121
<a name="id3664882"></a><h2>Description</h2>
 
122
<p>
 
123
 
 
124
The <a href="GtkDrawingArea.html" title="GtkDrawingArea"><span class="type">GtkDrawingArea</span></a> widget is used for creating custom user interface
 
125
elements. It's essentially a blank widget; you can draw on
 
126
<code class="literal">widget-&gt;window</code>. After creating a drawing area,
 
127
the application may want to connect to:
 
128
 
 
129
</p>
 
130
<div class="itemizedlist"><ul type="disc">
 
131
<li><p>
 
132
    Mouse and button press signals to respond to input from
 
133
    the user. (Use <a href="GtkWidget.html#gtk-widget-add-events"><code class="function">gtk_widget_add_events()</code></a> to enable events 
 
134
    you wish to receive.)
 
135
    </p></li>
 
136
<li><p>
 
137
    The "realize" signal to take any necessary actions
 
138
    when the widget is instantiated on a particular display.
 
139
    (Create GDK resources in response to this signal.)
 
140
    </p></li>
 
141
<li><p>
 
142
    The "configure_event" signal to take any necessary actions
 
143
    when the widget changes size.
 
144
    </p></li>
 
145
<li><p>
 
146
    The "expose_event" signal to handle redrawing the
 
147
    contents of the widget.
 
148
    </p></li>
 
149
</ul></div>
 
150
<p>
 
151
</p>
 
152
<p>
 
153
The following code portion demonstrates using a drawing
 
154
area to display a circle in the normal widget foreground 
 
155
color.
 
156
Note that GDK automatically clears the exposed area
 
157
to the background color before sending the expose event, and 
 
158
that drawing is implicitly clipped to the exposed area.
 
159
</p>
 
160
<div class="example">
 
161
<a name="id3664971"></a><p class="title"><b>Example&#160;33.&#160;Simple <span class="structname">GtkDrawingArea</span> usage.</b></p>
 
162
<div class="example-contents"><pre class="programlisting">
 
163
gboolean
 
164
expose_event_callback (GtkWidget *widget, GdkEventExpose *event, gpointer data)
 
165
{
 
166
  gdk_draw_arc (widget-&gt;window,
 
167
                widget-&gt;style-&gt;fg_gc[GTK_WIDGET_STATE (widget)],
 
168
                TRUE,
 
169
                0, 0, widget-&gt;allocation.width, widget-&gt;allocation.height,
 
170
                0, 64 * 360);
 
171
 
 
172
  return TRUE;
 
173
}
 
174
[...]
 
175
  GtkWidget *drawing_area = gtk_drawing_area_new ();
 
176
  gtk_widget_set_size_request (drawing_area, 100, 100);
 
177
  g_signal_connect (G_OBJECT (drawing_area), "expose_event",  
 
178
                    G_CALLBACK (expose_event_callback), NULL);
 
179
</pre></div>
 
180
</div>
 
181
<br class="example-break"><p>
 
182
Expose events are normally delivered when a drawing area first comes
 
183
onscreen, or when it's covered by another window and then uncovered
 
184
(exposed). You can also force an expose event by adding to the "damage
 
185
region" of the drawing area's window; <a href="GtkWidget.html#gtk-widget-queue-draw-area"><code class="function">gtk_widget_queue_draw_area()</code></a> and
 
186
<a
 
187
href="../gdk/gdk-Windows.html#gdk-window-invalidate-rect"
 
188
><code class="function">gdk_window_invalidate_rect()</code></a> are equally good ways to do this. You'll
 
189
then get an expose event for the invalid region.
 
190
</p>
 
191
<p>
 
192
The available routines for drawing are documented on the <a
 
193
href="../gdk/gdk-Drawing-Primitives.html"
 
194
>GDK Drawing Primitives</a> page.
 
195
See also <a
 
196
href="../gdk/gdk-Pixbufs.html#gdk-pixbuf-render-to-drawable"
 
197
><code class="function">gdk_pixbuf_render_to_drawable()</code></a> for drawing a <a
 
198
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
199
><span class="type">GdkPixbuf</span></a>.
 
200
</p>
 
201
<p>
 
202
To receive mouse events on a drawing area, you will need to enable
 
203
them with <a href="GtkWidget.html#gtk-widget-add-events"><code class="function">gtk_widget_add_events()</code></a>. To receive keyboard events, you
 
204
will need to set the <a href="GtkWidget.html#GTK-CAN-FOCUS:CAPS"><span class="type">GTK_CAN_FOCUS</span></a> flag on the drawing area, and
 
205
should probably draw some user-visible indication that the drawing
 
206
area is focused. Use the <a href="GtkWidget.html#GTK-HAS-FOCUS:CAPS"><code class="function">GTK_HAS_FOCUS()</code></a> macro in your expose event
 
207
handler to decide whether to draw the focus indicator. See
 
208
<a href="GtkStyle.html#gtk-paint-focus"><code class="function">gtk_paint_focus()</code></a> for one way to draw focus.
 
209
</p>
 
210
</div>
 
211
<div class="refsect1" lang="en">
 
212
<a name="id3665120"></a><h2>Details</h2>
 
213
<div class="refsect2" lang="en">
 
214
<a name="id3665130"></a><h3>
 
215
<a name="GtkDrawingArea-struct"></a>GtkDrawingArea</h3>
 
216
<a class="indexterm" name="id3665144"></a><pre class="programlisting">typedef struct _GtkDrawingArea GtkDrawingArea;</pre>
 
217
<p>
 
218
The <a href="GtkDrawingArea.html" title="GtkDrawingArea"><span class="type">GtkDrawingArea</span></a> struct contains private data only, and
 
219
should be accessed using the functions below.
 
220
</p>
 
221
</div>
 
222
<hr>
 
223
<div class="refsect2" lang="en">
 
224
<a name="id3665169"></a><h3>
 
225
<a name="gtk-drawing-area-new"></a>gtk_drawing_area_new ()</h3>
 
226
<a class="indexterm" name="id3665182"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>*          gtk_drawing_area_new                (void);</pre>
 
227
<p>
 
228
Creates a new drawing area.
 
229
</p>
 
230
<div class="variablelist"><table border="0">
 
231
<col align="left" valign="top">
 
232
<tbody><tr>
 
233
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
234
<td>a new <a href="GtkDrawingArea.html" title="GtkDrawingArea"><span class="type">GtkDrawingArea</span></a>
 
235
 
 
236
 
 
237
</td>
 
238
</tr></tbody>
 
239
</table></div>
 
240
</div>
 
241
<hr>
 
242
<div class="refsect2" lang="en">
 
243
<a name="id3665227"></a><h3>
 
244
<a name="gtk-drawing-area-size"></a>gtk_drawing_area_size ()</h3>
 
245
<a class="indexterm" name="id3665243"></a><pre class="programlisting">void                gtk_drawing_area_size               (<a href="GtkDrawingArea.html" title="GtkDrawingArea">GtkDrawingArea</a> *darea,
 
246
                                                         gint width,
 
247
                                                         gint height);</pre>
 
248
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
249
<h3 class="title">Warning</h3>
 
250
<p><code class="literal">gtk_drawing_area_size</code> is deprecated and should not be used in newly-written code.</p>
 
251
</div>
 
252
<p>
 
253
(Use <a href="GtkWidget.html#gtk-widget-set-size-request"><code class="function">gtk_widget_set_size_request()</code></a> instead.)
 
254
Sets the size that the drawing area will request
 
255
in response to a "size_request" signal. The 
 
256
drawing area may actually be allocated a size
 
257
larger than this depending on how it is packed
 
258
within the enclosing containers.
 
259
</p>
 
260
<div class="variablelist"><table border="0">
 
261
<col align="left" valign="top">
 
262
<tbody>
 
263
<tr>
 
264
<td><span class="term"><em class="parameter"><code>darea</code></em>&#160;:</span></td>
 
265
<td>a <a href="GtkDrawingArea.html" title="GtkDrawingArea"><span class="type">GtkDrawingArea</span></a>.
 
266
</td>
 
267
</tr>
 
268
<tr>
 
269
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
270
<td>the width to request.
 
271
</td>
 
272
</tr>
 
273
<tr>
 
274
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
275
<td>the height to request.
 
276
 
 
277
 
 
278
</td>
 
279
</tr>
 
280
</tbody>
 
281
</table></div>
 
282
</div>
 
283
</div>
 
284
<div class="refsect1" lang="en">
 
285
<a name="id3665370"></a><h2>See Also</h2>
 
286
<p>
 
287
Sometimes <a href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> is a useful alternative to a drawing area. 
 
288
You can put a <a
 
289
href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"
 
290
><span class="type">GdkPixmap</span></a> in the <a href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and draw to the <a
 
291
href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"
 
292
><span class="type">GdkPixmap</span></a>, 
 
293
calling <a href="GtkWidget.html#gtk-widget-queue-draw"><code class="function">gtk_widget_queue_draw()</code></a> on the <a href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> when you want to 
 
294
refresh to the screen.
 
295
</p>
 
296
</div>
 
297
</div>
 
298
</body>
 
299
</html>