~ubuntu-branches/ubuntu/quantal/gtkmm3.0/quantal

« back to all changes in this revision

Viewing changes to docs/reference/html/classGdk_1_1Window.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-03-01 23:42:36 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20120301234236-12w6m0hkomhi7h53
Tags: 3.3.16-0ubuntu1
* New upstream version
* debian/control.in: updated the glib requirement

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
 <tbody>
15
15
 <tr style="height: 56px;">
16
16
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.3.14</span></div>
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.3.16</span></div>
18
18
  </td>
19
19
 </tr>
20
20
 </tbody>
516
516
 
517
517
<p>Emits a short beep associated to <em>window</em> in the appropriate display, if supported. </p>
518
518
<p>Otherwise, emits a short beep on the display just as <a class="el" href="classGdk_1_1Display.html#a63ff8a09aa81f2bf1f7581ddba39fe69" title="Emits a short beep on display.">Gdk::Display::beep()</a>.</p>
519
 
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000007">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
519
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000006">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
520
520
 
521
521
</div>
522
522
</div>
558
558
<div class="memdoc">
559
559
 
560
560
<p>Begins a window move operation (for a toplevel window). </p>
561
 
<p>You might use this function to implement a "window move grip," for example. The function works best with window managers that support the Extended <a class="el" href="classGdk_1_1Window.html" title="A Gdk::Window is a rectangular region on the screen.">Window</a> Manager Hints, but has a fallback implementation for other window managers. </p>
 
561
<p>This function assumes that the drag is controlled by the client pointer device, use gdk_window_begin_move_drag_for_device() to begin a drag with a different device. </p>
562
562
<dl><dt><b>Parameters:</b></dt><dd>
563
563
  <table class="params">
564
564
    <tr><td class="paramname">button</td><td>The button being used to drag. </td></tr>
670
670
<div class="memdoc">
671
671
 
672
672
<p>Begins a window resize operation (for a toplevel window). </p>
673
 
<p>You might use this function to implement a "window resize grip," for example; in fact <a class="el" href="classGtk_1_1Statusbar.html" title="Text status indicator This widget is used to display status information.">Gtk::Statusbar</a> uses it. The function works best with window managers that support the Extended <a class="el" href="classGdk_1_1Window.html" title="A Gdk::Window is a rectangular region on the screen.">Window</a> Manager Hints, but has a fallback implementation for other window managers. </p>
 
673
<p>This function assumes that the drag is controlled by the client pointer device, use gdk_window_begin_resize_drag_for_device() to begin a drag with a different device. </p>
674
674
<dl><dt><b>Parameters:</b></dt><dd>
675
675
  <table class="params">
676
676
    <tr><td class="paramname">edge</td><td>The edge or corner from which the drag is started. </td></tr>
701
701
<p>Signal to the window system that the application has finished handling Configure events it has received. </p>
702
702
<p><a class="el" href="classGdk_1_1Window.html" title="A Gdk::Window is a rectangular region on the screen.">Window</a> Managers can use this to better synchronize the frame repaint with the application. GTK+ applications will automatically call this function when appropriate.</p>
703
703
<p>This function can only be called if <a class="el" href="classGdk_1_1Window.html#a356e4e19207606e91f87346a378e1b1f" title="Indicates that the application will cooperate with the window system in synchronizing the window repa...">enable_synchronized_configure()</a> was called previously.</p>
704
 
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000012">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
 
704
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000006">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
705
705
 
706
706
</div>
707
707
</div>
926
926
 
927
927
<p>Creates a <a class="el" href="namespaceGdk_1_1Cairo.html">Cairo</a> context for drawing to <em>drawable</em>. </p>
928
928
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly created <a class="el" href="namespaceGdk_1_1Cairo.html">Cairo</a> context.</dd></dl>
929
 
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000015">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
 
929
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000016">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
930
930
 
931
931
</div>
932
932
</div>
1043
1043
<p>Indicates that the application will cooperate with the window system in synchronizing the window repaint with the window manager during resizing operations. </p>
1044
1044
<p>After an application calls this function, it must call <a class="el" href="classGdk_1_1Window.html#aebb7266930dad01675f28abe8e5c4cf1" title="Signal to the window system that the application has finished handling Configure events it has receiv...">configure_finished()</a> every time it has finished all processing associated with a set of Configure events. Toplevel GTK+ windows automatically use this protocol.</p>
1045
1045
<p>On X, calling this function makes <em>window</em> participate in the _NET_WM_SYNC_REQUEST window manager protocol.</p>
1046
 
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000011">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
 
1046
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000005">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
1047
1047
 
1048
1048
</div>
1049
1049
</div>
1173
1173
<p>This means the window covers the entire screen and is above any panels or task bars.</p>
1174
1174
<p>If the window was already fullscreen, then this function does nothing.</p>
1175
1175
<p>On X11, asks the window manager to put <em>window</em> in a fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "fullscreen"; so you can't rely on the fullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.</p>
1176
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000063">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
1176
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000058">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
1177
1177
 
1178
1178
</div>
1179
1179
</div>
2156
2156
<p>Obtains the current pointer position and modifier state. </p>
2157
2157
<p>The position is given in coordinates relative to the upper left corner of <em>window</em>.</p>
2158
2158
<p>Deprecated: 3.0: Use <a class="el" href="classGdk_1_1Window.html#a37dfbd885e04cc322b1e2e10264894b6" title="Obtains the current device position and modifier state.">get_device_position()</a> instead. </p>
2159
 
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGdk_1_1Window.html#a37dfbd885e04cc322b1e2e10264894b6" title="Obtains the current device position and modifier state.">get_device_position()</a> instead </dd></dl>
 
2159
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGdk_1_1Window.html#a37dfbd885e04cc322b1e2e10264894b6" title="Obtains the current device position and modifier state.">get_device_position()</a> instead </dd></dl>
2160
2160
<dl><dt><b>Parameters:</b></dt><dd>
2161
2161
  <table class="params">
2162
2162
    <tr><td class="paramname">x</td><td>Return location for X coordinate of pointer or <code>0</code> to not return the X coordinate. </td></tr>
2457
2457
<div class="memdoc">
2458
2458
 
2459
2459
<p>This function returns the type hint set for a window. </p>
2460
 
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000014">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
 
2460
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000015">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
2461
2461
<dl class="return"><dt><b>Returns:</b></dt><dd>The type hint set for <em>window</em>. </dd></dl>
2462
2462
 
2463
2463
</div>
2763
2763
<p>An input shape is typically used with <a class="el" href="classGdk_1_1RGBA.html" title="An RGBA Color.">RGBA</a> windows. The alpha channel of the window defines which pixels are invisible and allows for nicely antialiased borders, and the input shape controls where the window is "clickable".</p>
2764
2764
<p>On the X11 platform, this requires version 1.1 of the shape extension.</p>
2765
2765
<p>On the Win32 platform, this functionality is not present and the function does nothing.</p>
2766
 
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000011">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
 
2766
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000012">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
2767
2767
<dl><dt><b>Parameters:</b></dt><dd>
2768
2768
  <table class="params">
2769
2769
    <tr><td class="paramname">shape_region</td><td>Region of window to be non-transparent. </td></tr>
3015
3015
<p>Merges the input shape masks for any child windows into the input shape mask for <em>window</em>. </p>
3016
3016
<p>i.e. the union of all input masks for <em>window</em> and its children will become the new input mask for <em>window</em>. See <a class="el" href="classGdk_1_1Window.html#aac2c9d614a46435a7812681fd95678d1" title="Like shape_combine_region(), but the shape applies only to event handling.">input_shape_combine_region()</a>.</p>
3017
3017
<p>This function is distinct from <a class="el" href="classGdk_1_1Window.html#a4c4a3eff84349ff97ecf1d24972cc751" title="Sets the input shape mask of window to the union of input shape masks for all children of window...">set_child_input_shapes()</a> because it includes <em>window's</em> input shape mask in the set of shapes to be merged.</p>
3018
 
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000013">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
 
3018
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000014">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
3019
3019
 
3020
3020
</div>
3021
3021
</div>
3617
3617
 
3618
3618
<p>Sets the background color of <em>window</em>. </p>
3619
3619
<p>(However, when using GTK+, set the background of a widget with gtk_widget_modify_bg() - if you're an application - or gtk_style_set_background() - if you're implementing a custom widget.)</p>
3620
 
<p>See also set_background_pattern(). </p>
 
3620
<p>See also set_background_pattern().</p>
 
3621
<p>Deprecated: 3.4: Use set_background_rgba() instead. </p>
 
3622
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use the <a class="el" href="classGdk_1_1Window.html#a3beabdcf6f6f2c36f03288aaba209863" title="Sets the background color of window.">set_background()</a> method that takes a <a class="el" href="classGdk_1_1RGBA.html" title="An RGBA Color.">Gdk::RGBA</a> instead. </dd></dl>
3621
3623
<dl><dt><b>Parameters:</b></dt><dd>
3622
3624
  <table class="params">
3623
3625
    <tr><td class="paramname">color</td><td>A <a class="el" href="classGdk_1_1Color.html" title="Gdk::Color is used to describe an allocated or unallocated color.">Gdk::Color</a>. </td></tr>
3643
3645
 
3644
3646
<p>Sets the input shape mask of <em>window</em> to the union of input shape masks for all children of <em>window</em>, ignoring the input shape mask of <em>window</em> itself. </p>
3645
3647
<p>Contrast with <a class="el" href="classGdk_1_1Window.html#adf4f0442926e39a327843a6b5946e4c5" title="Merges the input shape masks for any child windows into the input shape mask for window.">merge_child_input_shapes()</a> which includes the input shape mask of <em>window</em> in the masks to be merged.</p>
3646
 
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000012">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
 
3648
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000013">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
3647
3649
 
3648
3650
</div>
3649
3651
</div>
3686
3688
<p>It only makes sense for child windows to be composited; see <a class="el" href="classGdk_1_1Window.html#af70da6bc12c5997b6cd77f4cd14e5129" title="Request the windowing system to make window partially transparent, with opacity 0 being fully transpa...">set_opacity()</a> if you need translucent toplevel windows.</p>
3687
3689
<p>An additional effect of this call is that the area of this window is no longer clipped from regions marked for invalidation on its parent. Draws done on the parent window are also no longer clipped by the child.</p>
3688
3690
<p>This call is only supported on some systems (currently, only X11 with new enough Xcomposite and Xdamage extensions). You must call <a class="el" href="classGdk_1_1Display.html#aeb030dde7590e1b649f398e99da0c9b3" title="Returns true if Gdk::Window::set_composited() can be used to redirect drawing on the window using com...">Gdk::Display::supports_composite()</a> to check if setting a window as composited is supported before attempting to do so.</p>
3689
 
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000005">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
3691
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000004">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
3690
3692
<dl><dt><b>Parameters:</b></dt><dd>
3691
3693
  <table class="params">
3692
3694
    <tr><td class="paramname">composited</td><td><code>true</code> to set the window as composited. </td></tr>
3937
3939
<p>Setting <em>focus_on_map</em> to <code>false</code> hints the desktop environment that the window doesn't want to receive input focus when it is mapped. </p>
3938
3940
<p>focus_on_map should be turned off for windows that aren't triggered interactively (such as popups from network activity).</p>
3939
3941
<p>On X, it is the responsibility of the window manager to interpret this hint. Window managers following the freedesktop.org window manager extension specification should respect it.</p>
3940
 
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000013">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
 
3942
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000007">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
3941
3943
<dl><dt><b>Parameters:</b></dt><dd>
3942
3944
  <table class="params">
3943
3945
    <tr><td class="paramname">focus_on_map</td><td><code>true</code> if the window should receive input focus when mapped. </td></tr>
4194
4196
<div class="memdoc">
4195
4197
 
4196
4198
<p>Sets <em>window</em> to be embedded in <em>embedder</em>. </p>
4197
 
<p>To fully embed an offscreen window, in addition to calling this function, it is also necessary to handle the Gdk::Window::pick-embedded-child signal on the <em>embedder</em> and the Gdk::Window::to-embedder and Gdk::Window::from-embedder signals on <em>window</em>.</p>
 
4199
<p>To fully embed an offscreen window, in addition to calling this function, it is also necessary to handle the Gdk::Window::signal_pick_embedded_child() signal on the <em>embedder</em> and the Gdk::Window::signal_to_embedder() and Gdk::Window::signal_from_embedder() signals on <em>window</em>.</p>
4198
4200
<dl class="since_2_18"><dt><b><a class="el" href="since_2_18.html#_since_2_18000010">Since gtkmm 2.18:</a></b></dt><dd></dd></dl>
4199
4201
<dl><dt><b>Parameters:</b></dt><dd>
4200
4202
  <table class="params">
4225
4227
<p>(Values of the opacity parameter are clamped to the [0,1] range.)</p>
4226
4228
<p>On X11, this works only on X screens with a compositing manager running.</p>
4227
4229
<p>For setting up per-pixel alpha, see <a class="el" href="classGdk_1_1Screen.html#a20af3907afd8fc3098b0c9a34062c1d0" title="Gets a visual to use for creating windows with an alpha channel.">Gdk::Screen::get_rgba_visual()</a>. For making non-toplevel windows translucent, see <a class="el" href="classGdk_1_1Window.html#aba9d5bea3de05b31eff0da2bed753db8" title="Sets a Gdk::Window as composited, or unsets it.">set_composited()</a>.</p>
4228
 
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000008">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
4230
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000007">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
4229
4231
<dl><dt><b>Parameters:</b></dt><dd>
4230
4232
  <table class="params">
4231
4233
    <tr><td class="paramname">opacity</td><td>Opacity. </td></tr>
4305
4307
 
4306
4308
<p>Toggles whether a window should appear in a pager (workspace switcher, or other desktop utility program that displays a small thumbnail representation of the windows on the desktop). </p>
4307
4309
<p>If a window's semantic type as specified with <a class="el" href="classGdk_1_1Window.html#a4505331d1882e0e02d076782ddfaa2ff" title="The application can use this call to provide a hint to the window manager about the functionality of ...">set_type_hint()</a> already fully describes the window, this function should <em>not</em> be called in addition, instead you should allow the window to be treated according to standard policy for its semantic type.</p>
4308
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000062">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
4310
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000057">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
4309
4311
<dl><dt><b>Parameters:</b></dt><dd>
4310
4312
  <table class="params">
4311
4313
    <tr><td class="paramname">skips_pager</td><td><code>true</code> to skip the pager. </td></tr>
4332
4334
 
4333
4335
<p>Toggles whether a window should appear in a task list or window list. </p>
4334
4336
<p>If a window's semantic type as specified with <a class="el" href="classGdk_1_1Window.html#a4505331d1882e0e02d076782ddfaa2ff" title="The application can use this call to provide a hint to the window manager about the functionality of ...">set_type_hint()</a> already fully describes the window, this function should <em>not</em> be called in addition, instead you should allow the window to be treated according to standard policy for its semantic type.</p>
4335
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000061">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
4337
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000056">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
4336
4338
<dl><dt><b>Parameters:</b></dt><dd>
4337
4339
  <table class="params">
4338
4340
    <tr><td class="paramname">skips_taskbar</td><td><code>true</code> to skip the taskbar. </td></tr>
4396
4398
<div class="memdoc">
4397
4399
 
4398
4400
<p>When using GTK+, typically you should use gtk_window_set_startup_id() instead of this low-level function. </p>
4399
 
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000006">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
4401
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000005">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
4400
4402
<dl><dt><b>Parameters:</b></dt><dd>
4401
4403
  <table class="params">
4402
4404
    <tr><td class="paramname">startup_id</td><td>A string with startup-notification identifier. </td></tr>
4733
4735
<p>Moves the window out of fullscreen mode. </p>
4734
4736
<p>If the window was not fullscreen, does nothing.</p>
4735
4737
<p>On X11, asks the window manager to move <em>window</em> out of the fullscreen state, if the window manager supports this operation. Not all window managers support this, and some deliberately ignore it or don't have a concept of "fullscreen"; so you can't rely on the unfullscreenification actually happening. But it will happen with most standard window managers, and GDK makes a best effort to get it to happen.</p>
4736
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000064">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
4738
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000059">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
4737
4739
 
4738
4740
</div>
4739
4741
</div>
4853
4855
<li>gdkmm/window.h</li>
4854
4856
</ul>
4855
4857
</div>
4856
 
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 7 2012 10:44:06 for gtkmm by&#160;
 
4858
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 28 2012 10:01:53 for gtkmm by&#160;
4857
4859
<a href="http://www.doxygen.org/index.html">
4858
4860
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
4859
4861
</body>