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

« back to all changes in this revision

Viewing changes to docs/reference/html/classGdk_1_1Screen.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>
144
144
&lt; <a class="el" href="classGdk_1_1Window.html">Window</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Screen.html#aa3f2a37e845efcdd1d10c6ce275db544">get_window_stack</a> ()</td></tr>
145
145
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a List of Gdk::Windows representing the current window stack. <a href="#aa3f2a37e845efcdd1d10c6ce275db544"></a><br/></td></tr>
146
146
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Screen.html#ad3756022fbe94addcb3b2d6b9e4da4d3">signal_size_changed</a> ()</td></tr>
147
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The size_changed signal is emitted when the pixel width or height of a screen changes. <a href="#ad3756022fbe94addcb3b2d6b9e4da4d3"></a><br/></td></tr>
148
147
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Screen.html#a2867ce25ddb06e469f637c7feb84a510">signal_composited_changed</a> ()</td></tr>
149
148
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Screen.html#a20c232bf8aba84d3543e0db9f742d37c">signal_monitors_changed</a> ()</td></tr>
150
149
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><br class="typebreak"/>
252
251
 
253
252
<p>Gets the default screen for the default display. </p>
254
253
<p>(See <a class="el" href="classGdk_1_1Display.html#a0cbfb8aa89b6d2a7047b93909894b763" title="Gets the default Gdk::Display.">Gdk::Display::get_default()</a>).</p>
255
 
<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>
 
254
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000052">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
256
255
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGdk_1_1Screen.html" title="Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical sc...">Gdk::Screen</a>, or <code>0</code> if there is no default display. </dd></dl>
257
256
 
258
257
</div>
272
271
<div class="memdoc">
273
272
 
274
273
<p>Gets the display to which the <em>screen</em> belongs. </p>
275
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000044">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
274
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000038">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
276
275
<dl class="return"><dt><b>Returns:</b></dt><dd>The display to which <em>screen</em> belongs. </dd></dl>
277
276
 
278
277
</div>
292
291
<div class="memdoc">
293
292
 
294
293
<p>Gets the display to which the <em>screen</em> belongs. </p>
295
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000045">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
294
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000039">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
296
295
<dl class="return"><dt><b>Returns:</b></dt><dd>The display to which <em>screen</em> belongs. </dd></dl>
297
296
 
298
297
</div>
332
331
<div class="memdoc">
333
332
 
334
333
<p>Gets the height of <em>screen</em> in pixels. </p>
335
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000048">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
334
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000042">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
336
335
<dl class="return"><dt><b>Returns:</b></dt><dd>The height of <em>screen</em> in pixels. </dd></dl>
337
336
 
338
337
</div>
353
352
 
354
353
<p>Returns the height of <em>screen</em> in millimeters. </p>
355
354
<p>Note that on some X servers this value will not be correct.</p>
356
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000050">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
355
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000044">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
357
356
<dl class="return"><dt><b>Returns:</b></dt><dd>The heigth of <em>screen</em> in millimeters. </dd></dl>
358
357
 
359
358
</div>
384
383
<div class="memdoc">
385
384
 
386
385
<p>Returns the monitor number in which the point ( <em>x</em>, <em>y</em>) is located. </p>
387
 
<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>
 
386
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000050">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
388
387
<dl><dt><b>Parameters:</b></dt><dd>
389
388
  <table class="params">
390
389
    <tr><td class="paramname">x</td><td>The x coordinate in the virtual screen. </td></tr>
412
411
<div class="memdoc">
413
412
 
414
413
<p>Returns the number of the monitor in which the largest area of the bounding rectangle of <em>window</em> resides. </p>
415
 
<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>
 
414
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000051">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
416
415
<dl><dt><b>Parameters:</b></dt><dd>
417
416
  <table class="params">
418
417
    <tr><td class="paramname">window</td><td>A <a class="el" href="classGdk_1_1Window.html" title="A Gdk::Window is a rectangular region on the screen.">Gdk::Window</a>. </td></tr>
449
448
<div class="memdoc">
450
449
 
451
450
<p>Retrieves the <a class="el" href="classGdk_1_1Rectangle.html" title="Gdk::Rectangle is a structure holding the position and size of a rectangle.">Gdk::Rectangle</a> representing the size and position of the individual monitor within the entire screen area. </p>
 
451
<p>Monitor numbers start at 0. To obtain the number of monitors of <em>screen</em>, use <a class="el" href="classGdk_1_1Screen.html#afa47b24f2c133204be5816106a2d87a0" title="Returns the number of monitors which screen consists of.">get_n_monitors()</a>.</p>
452
452
<p>Note that the size of the entire screen area can be retrieved via <a class="el" href="classGdk_1_1Screen.html#a0ea643f504cd7aba79ce0c987e0dee3e" title="Gets the width of screen in pixels.">get_width()</a> and <a class="el" href="classGdk_1_1Screen.html#a4d0b1a971c87761d79e64c9e04ffe355" title="Gets the height of screen in pixels.">get_height()</a>.</p>
453
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000055">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
453
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000049">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
454
454
<dl><dt><b>Parameters:</b></dt><dd>
455
455
  <table class="params">
456
 
    <tr><td class="paramname">monitor_num</td><td>The monitor number, between 0 and gdk_screen_get_n_monitors (screen). </td></tr>
 
456
    <tr><td class="paramname">monitor_num</td><td>The monitor number. </td></tr>
457
457
    <tr><td class="paramname">dest</td><td>A <a class="el" href="classGdk_1_1Rectangle.html" title="Gdk::Rectangle is a structure holding the position and size of a rectangle.">Gdk::Rectangle</a> to be filled with the monitor geometry. </td></tr>
458
458
  </table>
459
459
  </dd>
477
477
<div class="memdoc">
478
478
 
479
479
<p>Gets the height in millimeters of the specified monitor. </p>
480
 
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000011">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
 
480
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000009">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
481
481
<dl><dt><b>Parameters:</b></dt><dd>
482
482
  <table class="params">
483
483
    <tr><td class="paramname">monitor_num</td><td>Number of the monitor, between 0 and gdk_screen_get_n_monitors (screen). </td></tr>
505
505
 
506
506
<p>Returns the output name of the specified monitor. </p>
507
507
<p>Usually something like VGA, DVI, or TV, not the actual product name of the display device.</p>
508
 
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000012">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
 
508
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000010">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
509
509
<dl><dt><b>Parameters:</b></dt><dd>
510
510
  <table class="params">
511
511
    <tr><td class="paramname">monitor_num</td><td>Number of the monitor, between 0 and gdk_screen_get_n_monitors (screen). </td></tr>
532
532
<div class="memdoc">
533
533
 
534
534
<p>Gets the width in millimeters of the specified monitor, if available. </p>
535
 
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000010">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
 
535
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000008">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
536
536
<dl><dt><b>Parameters:</b></dt><dd>
537
537
  <table class="params">
538
538
    <tr><td class="paramname">monitor_num</td><td>Number of the monitor, between 0 and gdk_screen_get_n_monitors (screen). </td></tr>
558
558
<div class="memdoc">
559
559
 
560
560
<p>Returns the number of monitors which <em>screen</em> consists of. </p>
561
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000054">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
561
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000048">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
562
562
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of monitors which <em>screen</em> consists of. </dd></dl>
563
563
 
564
564
</div>
579
579
 
580
580
<p>Gets the index of <em>screen</em> among the screens in the display to which it belongs. </p>
581
581
<p>(See <a class="el" href="classGdk_1_1Screen.html#a09a937007c4c386f2e32bd09e6017072" title="Gets the display to which the screen belongs.">get_display()</a>)</p>
582
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000046">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
582
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000040">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
583
583
<dl class="return"><dt><b>Returns:</b></dt><dd>The index. </dd></dl>
584
584
 
585
585
</div>
687
687
<div class="memdoc">
688
688
 
689
689
<p>Gets the root window of <em>screen</em>. </p>
690
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000042">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
690
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000036">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
691
691
<dl class="return"><dt><b>Returns:</b></dt><dd>The root window. </dd></dl>
692
692
 
693
693
</div>
707
707
<div class="memdoc">
708
708
 
709
709
<p>Gets the root window of <em>screen</em>. </p>
710
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000043">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
710
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000037">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
711
711
<dl class="return"><dt><b>Returns:</b></dt><dd>The root window. </dd></dl>
712
712
 
713
713
</div>
757
757
 
758
758
<p>Get the system's default visual for <em>screen</em>. </p>
759
759
<p>This is the visual for the root window of the display. The return value should not be freed.</p>
760
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000041">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
760
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000035">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
761
761
<dl class="return"><dt><b>Returns:</b></dt><dd>The system visual. </dd></dl>
762
762
 
763
763
</div>
778
778
 
779
779
<p>Get the system's default visual for <em>screen</em>. </p>
780
780
<p>This is the visual for the root window of the display. The return value should not be freed.</p>
781
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000040">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
781
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000034">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
782
782
<dl class="return"><dt><b>Returns:</b></dt><dd>The system visual. </dd></dl>
783
783
 
784
784
</div>
799
799
 
800
800
<p>Obtains a list of all toplevel windows known to GDK on the screen <em>screen</em>. </p>
801
801
<p>A toplevel window is a child of the root window (see gdk_get_default_root_window()). </p>
802
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000052">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
802
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000046">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
803
803
<dl class="return"><dt><b>Returns:</b></dt><dd>List of toplevel windows. </dd></dl>
804
804
 
805
805
</div>
819
819
<div class="memdoc">
820
820
 
821
821
<p>Gets the width of <em>screen</em> in pixels. </p>
822
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000047">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
822
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000041">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
823
823
<dl class="return"><dt><b>Returns:</b></dt><dd>The width of <em>screen</em> in pixels. </dd></dl>
824
824
 
825
825
</div>
840
840
 
841
841
<p>Gets the width of <em>screen</em> in millimeters. </p>
842
842
<p>Note that on some X servers this value will not be correct.</p>
843
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000049">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
843
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000043">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
844
844
<dl class="return"><dt><b>Returns:</b></dt><dd>The width of <em>screen</em> in millimeters. </dd></dl>
845
845
 
846
846
</div>
963
963
 
964
964
<p>Lists the available visuals for the specified <em>screen</em>. </p>
965
965
<p>A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format. </p>
966
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000051">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
966
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000045">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
967
967
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of visuals. </dd></dl>
968
968
 
969
969
</div>
983
983
<div class="memdoc">
984
984
 
985
985
<p>Determines the name to pass to <a class="el" href="classGdk_1_1Display.html#a59cf8e3302a66aa24ba43b0c47dae946" title="Opens a display.">Gdk::Display::open()</a> to get a <a class="el" href="classGdk_1_1Display.html" title="Gdk::Display object&#39;s purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To manage ...">Gdk::Display</a> with this screen as the default screen. </p>
986
 
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000053">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
 
986
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000047">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
987
987
<dl class="return"><dt><b>Returns:</b></dt><dd>The name. </dd></dl>
988
988
 
989
989
</div>
1135
1135
      </table>
1136
1136
</div>
1137
1137
<div class="memdoc">
1138
 
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_composited_changed()</code> </dd></dl>
 
1138
<dl class="user"><dt><b>Slot Prototype:</b></dt><dd><code>void on_my_composited_changed()</code></dd></dl>
 
1139
<p>The ::composited-changed signal is emitted when the composited status of the screen changes</p>
 
1140
<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>
1139
1141
 
1140
1142
</div>
1141
1143
</div>
1152
1154
      </table>
1153
1155
</div>
1154
1156
<div class="memdoc">
1155
 
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_monitors_changed()</code> </dd></dl>
 
1157
<dl class="user"><dt><b>Slot Prototype:</b></dt><dd><code>void on_my_monitors_changed()</code></dd></dl>
 
1158
<p>The ::monitors-changed signal is emitted when the number, size or position of the monitors attached to the screen change.</p>
 
1159
<p>Only for X11 and OS X for now. A future implementation for Win32 may be a possibility.</p>
 
1160
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000011">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
1156
1161
 
1157
1162
</div>
1158
1163
</div>
1169
1174
      </table>
1170
1175
</div>
1171
1176
<div class="memdoc">
1172
 
 
1173
 
<p>The size_changed signal is emitted when the pixel width or height of a screen changes. </p>
1174
 
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_size_changed()</code> </dd></dl>
 
1177
<dl class="user"><dt><b>Slot Prototype:</b></dt><dd><code>void on_my_size_changed()</code></dd></dl>
 
1178
<p>The <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01606.html#ga445a43f417432dd1b9aed90ef239c700">size</a>-changed signal is emitted when the pixel width or height of a screen changes.</p>
 
1179
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000053">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
1175
1180
 
1176
1181
</div>
1177
1182
</div>
1217
1222
<li>gdkmm/screen.h</li>
1218
1223
</ul>
1219
1224
</div>
1220
 
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 7 2012 10:44:06 for gtkmm by&#160;
 
1225
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 28 2012 10:01:52 for gtkmm by&#160;
1221
1226
<a href="http://www.doxygen.org/index.html">
1222
1227
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
1223
1228
</body>