mirror of
https://github.com/salvadordf/CEF4Delphi.git
synced 2025-06-02 21:57:37 +02:00
Added more XML documentation
This commit is contained in:
parent
9fa1b689d3
commit
0a118b39e2
@ -68,6 +68,10 @@ type
|
||||
{$ENDIF}
|
||||
|
||||
{$IFNDEF FPC}{$IFDEF DELPHI16_UP}[ComponentPlatformsAttribute(pfidWindows)]{$ENDIF}{$ENDIF}
|
||||
/// <summary>
|
||||
/// TBufferPanel is used by VCL and LCL applications with browsers in OSR mode
|
||||
/// to draw the browser contents. See the SimpleOSRBrowser demo for more details.
|
||||
/// </summary>
|
||||
TBufferPanel = class(TCustomPanel)
|
||||
protected
|
||||
FScanlineSize : integer;
|
||||
|
@ -74,21 +74,63 @@ type
|
||||
procedure InitializeDevToolsWindowInfo(aDevTools : TWinControl); virtual;
|
||||
public
|
||||
{$IFDEF MSWINDOWS}
|
||||
/// <summary>
|
||||
/// Used with browsers in OSR mode to initialize drag and drop in Windows.
|
||||
/// </summary>
|
||||
procedure InitializeDragAndDrop(const aDropTargetCtrl : TWinControl);
|
||||
{$ENDIF MSWINDOWS}
|
||||
|
||||
/// <summary>
|
||||
/// Open developer tools (DevTools) in its own browser. If inspectElementAt has a valid point
|
||||
/// with coordinates different than low(integer) then the element at the specified location
|
||||
/// will be inspected. If the DevTools browser is already open then it will be focused.
|
||||
/// </summary>
|
||||
procedure ShowDevTools(inspectElementAt: TPoint; const aDevTools : TWinControl = nil);
|
||||
/// <summary>
|
||||
/// Close the developer tools.
|
||||
/// </summary>
|
||||
procedure CloseDevTools(const aDevTools : TWinControl = nil);
|
||||
|
||||
/// <summary>
|
||||
/// Move the parent form to the x and y coordinates.
|
||||
/// </summary>
|
||||
procedure MoveFormTo(const x, y: Integer);
|
||||
/// <summary>
|
||||
/// Move the parent form adding x and y to the coordinates.
|
||||
/// </summary>
|
||||
procedure MoveFormBy(const x, y: Integer);
|
||||
/// <summary>
|
||||
/// Add x to the parent form width.
|
||||
/// </summary>
|
||||
procedure ResizeFormWidthTo(const x : Integer);
|
||||
/// <summary>
|
||||
/// Add y to the parent form height.
|
||||
/// </summary>
|
||||
procedure ResizeFormHeightTo(const y : Integer);
|
||||
/// <summary>
|
||||
/// Set the parent form left property to x.
|
||||
/// </summary>
|
||||
procedure SetFormLeftTo(const x : Integer);
|
||||
/// <summary>
|
||||
/// Set the parent form top property to y.
|
||||
/// </summary>
|
||||
procedure SetFormTopTo(const y : Integer);
|
||||
|
||||
/// <summary>
|
||||
/// Used to create the browser after the global request context has been
|
||||
/// initialized. You need to set all properties and events before calling
|
||||
/// this function because it will only create the internal handlers needed
|
||||
/// for those events and the property values will be used in the browser
|
||||
/// initialization.
|
||||
/// The browser will be fully initialized when the TChromiumCore.OnAfterCreated
|
||||
/// event is triggered.
|
||||
/// </summary>
|
||||
function CreateBrowser(const aBrowserParent : TWinControl = nil; const aWindowName : ustring = ''; const aContext : ICefRequestContext = nil; const aExtraInfo : ICefDictionaryValue = nil) : boolean; overload; virtual;
|
||||
/// Copy the DC to a bitmap stream. Only works on Windows with browsers without GPU acceleration.
|
||||
/// It's recommended to use the "Page.captureScreenshot" DevTools method instead.
|
||||
/// </summary>
|
||||
function SaveAsBitmapStream(const aStream : TStream) : boolean;
|
||||
/// <summary>
|
||||
/// Copy the DC to a TBitmap. Only works on Windows with browsers without GPU acceleration.
|
||||
/// It's recommended to use the "Page.captureScreenshot" DevTools method instead.
|
||||
/// </summary>
|
||||
function TakeSnapshot(var aBitmap : TBitmap) : boolean;
|
||||
end;
|
||||
|
||||
|
@ -58,6 +58,10 @@ type
|
||||
TDialogKeyEvent = procedure(Sender: TObject; var Key: Word; Shift: TShiftState) of object;
|
||||
|
||||
{$IFNDEF FPC}{$IFDEF DELPHI16_UP}[ComponentPlatformsAttribute(pfidWindows or pfidOSX or pfidLinux)]{$ENDIF}{$ENDIF}
|
||||
/// <summary>
|
||||
/// TBufferPanel is used by FMX applications with browsers in OSR mode
|
||||
/// to draw the browser contents. See the FMXExternalPumpBrowser demo for more details.
|
||||
/// </summary>
|
||||
TFMXBufferPanel = class(TControl)
|
||||
protected
|
||||
{$IFDEF MSWINDOWS}
|
||||
|
@ -69,20 +69,62 @@ type
|
||||
procedure InitializeDevToolsWindowInfo; virtual;
|
||||
|
||||
public
|
||||
/// <summary>
|
||||
/// Open developer tools (DevTools) in its own browser. If inspectElementAt has a valid point
|
||||
/// with coordinates different than low(integer) then the element at the specified location
|
||||
/// will be inspected. If the DevTools browser is already open then it will be focused.
|
||||
/// </summary>
|
||||
procedure ShowDevTools(inspectElementAt: TPoint);
|
||||
/// <summary>
|
||||
/// close the developer tools.
|
||||
/// </summary>
|
||||
procedure CloseDevTools;
|
||||
|
||||
/// <summary>
|
||||
/// Move the parent form to the x and y coordinates.
|
||||
/// </summary>
|
||||
procedure MoveFormTo(const x, y: Integer);
|
||||
/// <summary>
|
||||
/// Move the parent form adding x and y to the coordinates.
|
||||
/// </summary>
|
||||
procedure MoveFormBy(const x, y: Integer);
|
||||
/// <summary>
|
||||
/// Add x to the parent form width.
|
||||
/// </summary>
|
||||
procedure ResizeFormWidthTo(const x : Integer);
|
||||
/// <summary>
|
||||
/// Add y to the parent form height.
|
||||
/// </summary>
|
||||
procedure ResizeFormHeightTo(const y : Integer);
|
||||
/// <summary>
|
||||
/// Set the parent form left property to x.
|
||||
/// </summary>
|
||||
procedure SetFormLeftTo(const x : Integer);
|
||||
/// <summary>
|
||||
/// Set the parent form top property to y.
|
||||
/// </summary>
|
||||
procedure SetFormTopTo(const y : Integer);
|
||||
|
||||
/// <summary>
|
||||
/// Used to create the browser after the global request context has been
|
||||
/// initialized. You need to set all properties and events before calling
|
||||
/// this function because it will only create the internal handlers needed
|
||||
/// for those events and the property values will be used in the browser
|
||||
/// initialization.
|
||||
/// The browser will be fully initialized when the TChromiumCore.OnAfterCreated
|
||||
/// event is triggered.
|
||||
/// </summary>
|
||||
function CreateBrowser(const aWindowName : ustring = ''; const aContext : ICefRequestContext = nil; const aExtraInfo : ICefDictionaryValue = nil) : boolean; overload; virtual;
|
||||
/// <summary>
|
||||
/// Copy the DC to a bitmap stream. Only works on Windows with browsers without GPU acceleration.
|
||||
/// It's recommended to use the "Page.captureScreenshot" DevTools method instead.
|
||||
/// </summary>
|
||||
function SaveAsBitmapStream(const aStream : TStream; const aRect : System.Types.TRect) : boolean;
|
||||
/// <summary>
|
||||
/// Takes a snapshot into a TBitmap using the SaveAsBitmapStream function.
|
||||
/// </summary>
|
||||
function TakeSnapshot(var aBitmap : TBitmap; const aRect : System.Types.TRect) : boolean;
|
||||
|
||||
/// <summary>
|
||||
/// Returns the screen scale of the monitor where the parent form is located.
|
||||
/// </summary>
|
||||
property ScreenScale : single read GetScreenScale;
|
||||
end;
|
||||
|
||||
|
@ -65,6 +65,16 @@ uses
|
||||
|
||||
type
|
||||
{$IFNDEF FPC}{$IFDEF DELPHI16_UP}[ComponentPlatformsAttribute(pfidWindows)]{$ENDIF}{$ENDIF}
|
||||
/// <summary>
|
||||
/// This component can be used by VCL and LCL applications. It has the
|
||||
/// same purpose as TCEFWindowParent but it has a Chromium property to
|
||||
/// link it directly to a TChromium component.
|
||||
/// TCEFLinkedWindowParent resizes the child controls created by CEF
|
||||
/// for browsers in normal mode and sets the browser focus using the
|
||||
/// linked TChromium component. TCEFWindowParent and TCEFLinkedWindowParent
|
||||
/// work fine in Windows and you can used any of them but you can't use
|
||||
/// TCEFWindowParent in Linux or MacOS.
|
||||
/// </summary>
|
||||
TCEFLinkedWindowParent = class(TCEFLinkedWinControlBase)
|
||||
protected
|
||||
FChromium : TChromium;
|
||||
|
@ -78,6 +78,13 @@ type
|
||||
TSentinelStatus = (ssIdle, ssInitialDelay, ssCheckingChildren, ssClosing);
|
||||
|
||||
{$IFNDEF FPC}{$IFDEF DELPHI16_UP}[ComponentPlatformsAttribute(pfidWindows or pfidOSX or pfidLinux)]{$ENDIF}{$ENDIF}
|
||||
/// <summary>
|
||||
/// TCEFSentinel is used as a timer that checks the number of running
|
||||
/// CEF processes when you close all browsers before shutdown.
|
||||
/// This component is only used as a last resort when there's an unresolved
|
||||
/// shutdown issue in CEF or CEF4Delphi that generates exceptions when the
|
||||
/// application is closed.
|
||||
/// </summary>
|
||||
TCEFSentinel = class(TComponent)
|
||||
protected
|
||||
{$IFDEF MSWINDOWS}
|
||||
|
@ -2,7 +2,7 @@
|
||||
"UpdateLazPackages" : [
|
||||
{
|
||||
"ForceNotify" : true,
|
||||
"InternalVersion" : 501,
|
||||
"InternalVersion" : 502,
|
||||
"Name" : "cef4delphi_lazarus.lpk",
|
||||
"Version" : "115.3.13"
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user