1
0
mirror of https://github.com/salvadordf/CEF4Delphi.git synced 2026-04-23 01:13:01 +02:00
Files

287 lines
17 KiB
HTML
Raw Permalink Normal View History

2024-02-24 12:01:31 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<title>cef4delphi: uCEFDisplay: Class TCefDisplayRef</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
2026-04-04 18:01:24 +02:00
<meta name="generator" content="PasDoc 1.0.4">
2024-02-24 12:01:31 +01:00
<meta http-equiv="content-type" content="text/html; charset=utf-8">
2026-03-19 13:17:28 +01:00
<link rel="StyleSheet" type="text/css" href="bootstrap.min.css">
2024-02-24 12:01:31 +01:00
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
2026-03-30 18:44:20 +02:00
<style type="text/css">
body { margin: 0.5em; }
.badge { padding: 0.1em 0.5em; color: white; }
</style></head>
2024-02-24 12:01:31 +01:00
<body>
<span id="TCefDisplayRef"></span><h1 class="cio">Class TCefDisplayRef</h1>
<div class="sections">
2026-03-19 13:17:28 +01:00
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div></div>
2024-02-24 12:01:31 +01:00
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uCEFDisplay.html">uCEFDisplay</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCefDisplayRef = class(<a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a>, <a class="normal" href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>)</code></p>
<h2 class="description">Description</h2>
<p>
2025-05-30 16:54:28 +02:00
<p>This interface typically, but not always, corresponds to a physical display connected to the system. A fake Display may exist on a headless system, or a Display may correspond to a remote, virtual display. All size and position values are in density independent pixel (DIP) coordinates unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.
2026-03-19 13:17:28 +01:00
<p>For details on coordinate systems and usage see <a href="https://chromiumembedded.github.io/cef/general_usage#coordinate-systems">https://chromiumembedded.github.io/cef/general_usage#coordinate-systems</a>
2025-05-30 16:54:28 +02:00
<p></p>
2024-02-24 12:01:31 +01:00
<p>
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/views/cef_display_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/views/cef_display_capi.h</a>&quot;&gt;CEF source file: /include/capi/views/cef_display_capi.h (cef_display_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TInterfacedObject</li>
<li class="ancestor"><a class="normal" href="uCEFBaseRefCounted.TCefBaseRefCountedRef.html">TCefBaseRefCountedRef</a></li>
<li class="thisitem">TCefDisplayRef</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
2026-03-19 13:17:28 +01:00
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetID">GetID</a></strong>: int64;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetDeviceScaleFactor">GetDeviceScaleFactor</a></strong>: Single;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>procedure <strong><a href="uCEFDisplay.TCefDisplayRef.html#ConvertPointToPixels-TCefPoint-">ConvertPointToPixels</a></strong>(var point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>);</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>procedure <strong><a href="uCEFDisplay.TCefDisplayRef.html#ConvertPointFromPixels-TCefPoint-">ConvertPointFromPixels</a></strong>(var point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>);</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetBounds">GetBounds</a></strong>: <a href="uCEFTypes.TCefRect.html">TCefRect</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetWorkArea">GetWorkArea</a></strong>: <a href="uCEFTypes.TCefRect.html">TCefRect</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetRotation">GetRotation</a></strong>: Integer;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#UnWrap-Pointer-">UnWrap</a></strong>(data: Pointer): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#Primary">Primary</a></strong>: <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#NearestPoint-TCefPoint-boolean-">NearestPoint</a></strong>(const point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>; input_pixel_coords: boolean): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#MatchingBounds-TCefRect-boolean-">MatchingBounds</a></strong>(const bounds: <a href="uCEFTypes.TCefRect.html">TCefRect</a>; input_pixel_coords: boolean): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetCount">GetCount</a></strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#GetAlls-TCefDisplayArray-">GetAlls</a></strong>(var aDisplayArray : <a href="uCEFInterfaces.html#TCefDisplayArray">TCefDisplayArray</a>) : boolean;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#ScreenPointToPixels-TPoint-">ScreenPointToPixels</a></strong>(const aScreenPoint : TPoint) : TPoint;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#ScreenPointFromPixels-TPoint-">ScreenPointFromPixels</a></strong>(const aPixelsPoint : TPoint) : TPoint;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list2 visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#ScreenRectToPixels-TRect-">ScreenRectToPixels</a></strong>(const aScreenRect : TRect) : TRect;</code></td>
</tr>
2026-03-19 13:17:28 +01:00
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><code>class function <strong><a href="uCEFDisplay.TCefDisplayRef.html#ScreenRectFromPixels-TRect-">ScreenRectFromPixels</a></strong>(const aPixelsRect : TRect) : TRect;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetID"></span><code>function <strong>GetID</strong>: int64;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the unique identifier for this Display. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetDeviceScaleFactor"></span><code>function <strong>GetDeviceScaleFactor</strong>: Single;</code></td>
</tr>
<tr><td colspan="2">
<p>
2025-05-30 16:54:28 +02:00
Returns this Display's device pixel scale factor. This specifies how much the UI should be scaled when the actual output has more pixels than standard displays (which is around 100~120dpi). The potential return values differ by platform. Windowed browsers with 1.0 zoom will have a JavaScript `window.devicePixelRatio` value matching the associated Display's get_device_scale_factor() value. </p>
2024-02-24 12:01:31 +01:00
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ConvertPointToPixels-TCefPoint-"></span><code>procedure <strong>ConvertPointToPixels</strong>(var point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |point| from DIP coordinates to pixel coordinates using this Display's device scale factor. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ConvertPointFromPixels-TCefPoint-"></span><code>procedure <strong>ConvertPointFromPixels</strong>(var point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |point| from pixel coordinates to DIP coordinates using this Display's device scale factor. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetBounds"></span><code>function <strong>GetBounds</strong>: <a href="uCEFTypes.TCefRect.html">TCefRect</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns this Display's bounds in DIP screen coordinates. This is the full size of the display. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetWorkArea"></span><code>function <strong>GetWorkArea</strong>: <a href="uCEFTypes.TCefRect.html">TCefRect</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns this Display's work area in DIP screen coordinates. This excludes areas of the display that are occupied with window manager toolbars, etc. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-protected wide_list">
<tr class="list visibility-protected">
<td class="visibility"><span class="badge vis-protected">Protected</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetRotation"></span><code>function <strong>GetRotation</strong>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns this Display's rotation in degrees. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="UnWrap-Pointer-"></span><code>class function <strong>UnWrap</strong>(data: Pointer): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns a ICefDisplay instance using a PCefDisplay data pointer. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="Primary"></span><code>class function <strong>Primary</strong>: <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the primary Display. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="NearestPoint-TCefPoint-boolean-"></span><code>class function <strong>NearestPoint</strong>(const point: <a href="uCEFTypes.TCefPoint.html">TCefPoint</a>; input_pixel_coords: boolean): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the Display nearest |point|. Set |input_pixel_coords| to true (1) if |point| is in pixel screen coordinates instead of DIP screen coordinates. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="MatchingBounds-TCefRect-boolean-"></span><code>class function <strong>MatchingBounds</strong>(const bounds: <a href="uCEFTypes.TCefRect.html">TCefRect</a>; input_pixel_coords: boolean): <a href="uCEFInterfaces.ICefDisplay.html">ICefDisplay</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the Display that most closely intersects |bounds|. Set |input_pixel_coords| to true (1) if |bounds| is in pixel screen coordinates instead of DIP screen coordinates. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetCount"></span><code>class function <strong>GetCount</strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the total number of Displays. Mirrored displays are excluded; this function is intended to return the number of distinct, usable displays. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="GetAlls-TCefDisplayArray-"></span><code>class function <strong>GetAlls</strong>(var aDisplayArray : <a href="uCEFInterfaces.html#TCefDisplayArray">TCefDisplayArray</a>) : boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns all Displays. Mirrored displays are excluded; this function is intended to return distinct, usable displays. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ScreenPointToPixels-TPoint-"></span><code>class function <strong>ScreenPointToPixels</strong>(const aScreenPoint : TPoint) : TPoint;</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |point| from DIP screen coordinates to pixel screen coordinates. This function is only used on Windows. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ScreenPointFromPixels-TPoint-"></span><code>class function <strong>ScreenPointFromPixels</strong>(const aPixelsPoint : TPoint) : TPoint;</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |point| from pixel screen coordinates to DIP screen coordinates. This function is only used on Windows. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ScreenRectToPixels-TRect-"></span><code>class function <strong>ScreenRectToPixels</strong>(const aScreenRect : TRect) : TRect;</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |rect| from DIP screen coordinates to pixel screen coordinates. This function is only used on Windows. </p>
</td></tr>
</table>
2026-03-19 13:17:28 +01:00
<table class="detail visibility-public wide_list">
<tr class="list visibility-public">
<td class="visibility"><span class="badge vis-public">Public</span></td>
2024-02-24 12:01:31 +01:00
<td class="itemcode"><span id="ScreenRectFromPixels-TRect-"></span><code>class function <strong>ScreenRectFromPixels</strong>(const aPixelsRect : TRect) : TRect;</code></td>
</tr>
<tr><td colspan="2">
<p>
Convert |rect| from pixel screen coordinates to DIP screen coordinates. This function is only used on Windows. </p>
</td></tr>
</table>
2026-04-04 18:01:24 +02:00
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 1.0.4</a>. </em>
2024-02-24 12:01:31 +01:00
</span>
</body></html>