You've already forked CEF4Delphi
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:
@@ -64,6 +64,9 @@ uses
|
||||
|
||||
type
|
||||
{$IFNDEF FPC}{$IFDEF DELPHI16_UP}[ComponentPlatformsAttribute(pfidWindows or pfidOSX or pfidLinux)]{$ENDIF}{$ENDIF}
|
||||
/// <summary>
|
||||
/// The TCEFUrlRequestClientComponent class puts together all CEF URL request procedures, functions, properties and events in one place.
|
||||
/// </summary>
|
||||
TCEFUrlRequestClientComponent = class(TComponent, ICEFUrlRequestClientEvents)
|
||||
protected
|
||||
FClient : ICefUrlrequestClient;
|
||||
@@ -92,18 +95,81 @@ type
|
||||
constructor Create(AOwner: TComponent); override;
|
||||
procedure AfterConstruction; override;
|
||||
procedure BeforeDestruction; override;
|
||||
|
||||
/// <summary>
|
||||
/// Create the URLRequest in the context of TCEFUrlRequestClientComponent.ThreadId, which is the CEF UI thread by default.
|
||||
/// </summary>
|
||||
procedure AddURLRequest;
|
||||
|
||||
/// <summary>
|
||||
/// Returns the client.
|
||||
/// </summary>
|
||||
property Client : ICefUrlrequestClient read FClient;
|
||||
/// <summary>
|
||||
/// CEF thread used to create the URLRequest. Most of the client events will be executed on the same thread.
|
||||
/// </summary>
|
||||
property ThreadID : TCefThreadId read FThreadID write FThreadID;
|
||||
|
||||
published
|
||||
/// <summary>
|
||||
/// Notifies the client that the request has completed. Use the
|
||||
/// ICefUrlRequest.GetRequestStatus function to determine if the request
|
||||
/// was successful or not.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>This event will be called on the TCEFUrlRequestClientComponent.ThreadId thread, which is the CEF UI thread by default.</para>
|
||||
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_urlrequest_capi.h">CEF source file: /include/capi/cef_urlrequest_capi.h (cef_urlrequest_client_t)</see></para>
|
||||
/// </remarks>
|
||||
property OnRequestComplete : TOnRequestComplete read FOnRequestComplete write FOnRequestComplete;
|
||||
/// <summary>
|
||||
/// Notifies the client of upload progress. |current| denotes the number of
|
||||
/// bytes sent so far and |total| is the total size of uploading data (or -1
|
||||
/// if chunked upload is enabled). This function will only be called if the
|
||||
/// UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>This event will be called on the TCEFUrlRequestClientComponent.ThreadId thread, which is the CEF UI thread by default.</para>
|
||||
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_urlrequest_capi.h">CEF source file: /include/capi/cef_urlrequest_capi.h (cef_urlrequest_client_t)</see></para>
|
||||
/// </remarks>
|
||||
property OnUploadProgress : TOnUploadProgress read FOnUploadProgress write FOnUploadProgress;
|
||||
/// <summary>
|
||||
/// Notifies the client of download progress. |current| denotes the number of
|
||||
/// bytes received up to the call and |total| is the expected total size of
|
||||
/// the response (or -1 if not determined).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>This event will be called on the TCEFUrlRequestClientComponent.ThreadId thread, which is the CEF UI thread by default.</para>
|
||||
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_urlrequest_capi.h">CEF source file: /include/capi/cef_urlrequest_capi.h (cef_urlrequest_client_t)</see></para>
|
||||
/// </remarks>
|
||||
property OnDownloadProgress : TOnDownloadProgress read FOnDownloadProgress write FOnDownloadProgress;
|
||||
/// <summary>
|
||||
/// Called when some part of the response is read. |data| contains the current
|
||||
/// bytes received since the last call. This function will not be called if
|
||||
/// the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>This event will be called on the TCEFUrlRequestClientComponent.ThreadId thread, which is the CEF UI thread by default.</para>
|
||||
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_urlrequest_capi.h">CEF source file: /include/capi/cef_urlrequest_capi.h (cef_urlrequest_client_t)</see></para>
|
||||
/// </remarks>
|
||||
property OnDownloadData : TOnDownloadData read FOnDownloadData write FOnDownloadData;
|
||||
/// <summary>
|
||||
/// Called on the IO thread when the browser needs credentials from the user.
|
||||
/// |isProxy| indicates whether the host is a proxy server. |host| contains
|
||||
/// the hostname and |port| contains the port number. Return true (1) to
|
||||
/// continue the request and call ICefAuthCallback.cont() when the
|
||||
/// authentication information is available. If the request has an associated
|
||||
/// browser/frame then returning false (0) will result in a call to
|
||||
/// GetAuthCredentials on the ICefRequestHandler associated with that
|
||||
/// browser, if any. Otherwise, returning false (0) will cancel the request
|
||||
/// immediately. This function will only be called for requests initiated from
|
||||
/// the browser process.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>This event will be called on the browser process CEF IO thread.</para>
|
||||
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_urlrequest_capi.h">CEF source file: /include/capi/cef_urlrequest_capi.h (cef_urlrequest_client_t)</see></para>
|
||||
/// </remarks>
|
||||
property OnGetAuthCredentials : TOnGetAuthCredentials read FOnGetAuthCredentials write FOnGetAuthCredentials;
|
||||
/// <summary>
|
||||
/// Event triggered when the URLRequest has been created.
|
||||
/// </summary>
|
||||
property OnCreateURLRequest : TNotifyEvent read FOnCreateURLRequest write FOnCreateURLRequest;
|
||||
end;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user