1
0
mirror of https://github.com/salvadordf/CEF4Delphi.git synced 2025-11-23 21:34:53 +02:00

Added more XML documentation.

This commit is contained in:
salvadordf
2023-09-26 12:20:22 +02:00
parent 69adbfb115
commit f44c9ebbeb
5 changed files with 223 additions and 2 deletions

View File

@@ -61,23 +61,76 @@ type
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
procedure AfterConstruction; override;
/// <summary>
/// Save the visible web contents as a bitmap file.
/// </summary>
function SaveToFile(const aFilename : string) : boolean;
/// <summary>
/// Invalidate this panel.
/// </summary>
procedure InvalidatePanel;
/// <summary>
/// Acquires the synchronization object before drawing into the background bitmap.
/// </summary>
function BeginBufferDraw : boolean;
/// <summary>
/// Releases the synchronization object after drawing into the background bitmap.
/// </summary>
procedure EndBufferDraw;
/// <summary>
/// Draws a part of aBitmap into the background bitmap buffer at the specified rectangle.
/// </summary>
/// <param name="aBitmap">Bitmap that will be drawn into the background bitmap.</param>
/// <param name="aSrcRect">Rectangle that defines the area of aBitmap that will be drawn into the background bitmap.</param>
/// <param name="aDstRect">Rectangle that defines the area of the background bitmap where aBitmap will be drawn.</param>
procedure BufferDraw(const aBitmap : TBitmap; const aSrcRect, aDstRect : TRectF);
/// <summary>
/// Update the background bitmap size.
/// </summary>
function UpdateBufferDimensions(aWidth, aHeight : integer) : boolean;
/// <summary>
/// Check if the background image buffers have the same dimensions as this panel. Returns true if they have the same size.
/// </summary>
function BufferIsResized(aUseMutex : boolean = True) : boolean;
/// <summary>
/// Convert a point from the screen coordinate system to the client coordinate system.
/// </summary>
function ScreenToClient(aPoint : TPoint) : TPoint; overload;
/// <summary>
/// Convert a point from the screen coordinate system to the client coordinate system.
/// </summary>
function ScreenToClient(aPoint : TPointF) : TPointF; overload;
/// <summary>
/// Convert a point from the client coordinate system to the screen coordinate system.
/// </summary>
function ClientToScreen(aPoint : TPoint) : TPoint; overload;
/// <summary>
/// Convert a point from the client coordinate system to the screen coordinate system.
/// </summary>
function ClientToScreen(aPoint : TPointF) : TPointF; overload;
/// <summary>
/// Background bitmap.
/// </summary>
property Buffer : TBitmap read FBuffer;
/// <summary>
/// Returns the scanline size.
/// </summary>
property ScanlineSize : integer read FScanlineSize;
/// <summary>
/// Image width.
/// </summary>
property BufferWidth : integer read GetBufferWidth;
/// <summary>
/// Image height.
/// </summary>
property BufferHeight : integer read GetBufferHeight;
/// <summary>
/// Returns the screen scale.
/// </summary>
property ScreenScale : single read GetScreenScale;
/// <summary>
/// Screen scale value used instead of the real one.
/// </summary>
property ForcedDeviceScaleFactor : single read FForcedDeviceScaleFactor write FForcedDeviceScaleFactor;
published
@@ -86,7 +139,13 @@ type
property Visible;
property Enabled;
property TabOrder;
/// <summary>
/// Color used to clear the panel canvas in the Paint method.
/// </summary>
property Color : TAlphaColor read FColor write FColor default claWhite;
/// <summary>
/// Set HighSpeedDrawing to True to draw the buffer to the canvas using a high speed interpolation mode.
/// </summary>
property HighSpeedDrawing : boolean read FHighSpeedDrawing write FHighSpeedDrawing default True;
{$IFDEF DELPHI17_UP}
@@ -126,6 +185,9 @@ type
property OnMouseWheel;
property OnKeyUp;
property OnKeyDown;
/// <summary>
/// Event triggered before the DialogKey.
/// </summary>
property OnDialogKey : TDialogKeyEvent read FOnDialogKey write FOnDialogKey;
end;