Documentazione di Steamworks
Interfaccia ISteamHTMLSurface
Interfaccia per visualizzare e interagire con pagine HTML.

Puoi utilizzare questa interfaccia per visualizzare e mostrare pagine HTML direttamente all'interno del tuo gioco o della tua applicazione. Prima di usare questa interfaccia devi chiamare Init e, quando hai finito, Shutdown.

Si basa sul Chromium Embedded Framework e supporta il markup HTML5.

Per ulteriori informazioni, vedi Steam HTML Surface.

Funzioni membro

Le funzioni membro per ISteamHTMLSurface vengono chiamate tramite la funzione globale di accesso SteamHTMLSurface().

AddHeader

void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie su cui aggiungere l'intestazione.
pchKeyconst char *Il nome dell'intestazione da aggiungere.
pchValueconst char *Il valore dell'intestazione da associare alla chiave.

Aggiunge un'intestazione a qualunque richiesta HTTP da questo browser.

Una lista completa dei campi di richiesta predefiniti sono disponibili su questo articolo di wikipedia.

AllowStartRequest

void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che si sta navigando.
bAllowedboolConsente o rifiuta la navigazione alla richiesta di inizio corrente.

Imposta se un caricamento in sospeso è consentito o se deve essere annullato.
NOTE:DEVI effettuare questa chiamata in risposta a una callback HTML_StartRequest_t.

Puoi usare questa funzionalità per limitare le pagine valide consentite sulla tua superficie HTML.

CopyToClipboard

void CopyToClipboard( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie da cui copiare il testo.

Copia il testo al momento selezionato dalla pagina corrente a una superficie HTML negli appunti locali.

CreateBrowser

SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );
NomeTipoDescrizione
pchUserAgentconst char *Aggiunge la stringa alla stringa dell'agente dell'utente generico nel browser, consentendoti di rilevare il tuo client sui server web. Se non hai bisogno di questa funzionalità, utilizza NULL.
pchUserCSSconst char *Ti consente di impostare uno stile CSS per ogni pagina visualizzata da questo browser. Se non hai bisogno di questa funzionalità, utilizza NULL.

Crea un oggetto del browser da visualizzare su una pagina HTML.
NOTA: devi avere implementato gli handler delle callback per HTML_BrowserReady_t, HTML_StartRequest_t, HTML_JSAlert_t, HTML_JSConfirm_t, e HTML_FileOpenDialog_t!
Se non li implementi, il browser potrebbe apparire bloccato invece che caricare nuove pagine o attivare notifiche tramite javascript!

NOTE: quando hai finito di usare questo browser, DEVI chiamare RemoveBrowser per liberare le risorse associate. Non farlo risulterà in una perdita di memoria.

Per iniziare a usare la tua superficie di visualizzazione, chiama SetSize e LoadURL.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a HTML_BrowserReady_t.

ExecuteJavascript

void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che si sta navigando.
pchScriptconst char *Lo javascript da eseguire.

Esegue uno javascript nella pagina attualmente caricata.

FileLoadDialogResponse

void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che vuole fare apparire una finestra di notifica per aprire un file.
pchSelectedFilesconst char **Una matrice di percorsi assoluti che puntano ai file selezionati dall'utente. NULL se l'utente non ha selezionato alcun file.

Consente di reagire a una pagina che vuole aprire una finestra di dialogo per caricare un file.
NOTE:DEVI effettuare questa chiamata in risposta a una callback HTML_FileOpenDialog_t.

Find

void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie in cui trovare la stringa.
pchSearchStrconst char *La stringa da cercare.
bCurrentlyInFindboolImposta su true sulle chiamate successive per scorrere fino alla stringa seguente corrispondente.
bReverseboolInizia a cercare dal fondo?

Trova una stringa nella pagina corrente di una superficie HTML.

Equivale a premere "CTRL+F" sul tuo browser. Tutte le stringhe corrispondenti verranno evidenziate.

Dovresti chiamare StopFind quando la stringa inserita cambia o se vuoi interrompere la ricerca.

Restituisce: void
Attiva una callback HTML_SearchResults_t.

GetLinkAtPosition

void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie da cui ottenere un link.
xintLa posizione X (larghezza) in pixel all'interno della superficie. (0, 0) è l'angolo in alto a sinistra.
yintLa posizione Y (altezza) in pixel all'interno della superficie. (0, 0) è l'angolo in alto a sinistra.

Recupera dettagli su di un collegamento a una specifica posizione sulla pagina corrente di una superficie HTML.

Restituisce: void
Attiva una callback HTML_LinkAtPosition_t.

GoBack

void GoBack( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui tornare.

Torna indietro nella cronologia della pagina.

GoForward

void GoForward( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie su cui andare avanti.

Va avanti nella cronologia della pagina.

Init

bool Init();
Inizializza l'API si superficie HTML.

Da chiamare prima di usare le altre funzionalità di questa interfaccia.

Quando hai finito di usare questa interfaccia, DEVI chiamare Shutdown per liberare le risorse associate. Non farlo risulterà in una perdita di memoria!

Restituisce: bool
true se l'API è stata avviata con successo. Altrimenti, false.

JSDialogResponse

void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che sta facendo apparire una finestra di dialogo.
bResultboolImposta su true per simulare la pressione del pulsante "OK", o false per quello "Annulla".

Consente di reagire a una pagina che vuole aprire una finestra di dialogo javascript modale.
NOTA:DEVI effettuare questa chiamata in risposta alle callback HTML_JSAlert_t e HTML_JSConfirm_t.

KeyChar

void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
cUnicodeCharuint32Il punto del carattere unicode del tasto premuto. Potrebbe corrispondere a più di un carattere per pressione.
eHTMLKeyModifiersEHTMLKeyModifiersDovrebbe essere impostata su una maschera di bit dei tasti di modifica che l'utente sta premendo.

cUnicodeChar è il punto del carattere unicode del tasto premuto. Potrebbe corrispondere a più di un carattere per pressione.

KeyDown

void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
nNativeKeyCodeuint32Il valore del codice tasto virtuale proveniente dal sistema operativo.
eHTMLKeyModifiersEHTMLKeyModifiersDovrebbe essere impostata su una maschera di bit dei tasti di modifica che l'utente sta premendo.

Interazioni con la tastiera. Il codice tasto nativo è il codice tasto virtuale proveniente dal tuo sistema operativo.

KeyUp

void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
nNativeKeyCodeuint32Il valore del codice tasto virtuale proveniente dal sistema operativo.
eHTMLKeyModifiersEHTMLKeyModifiersDovrebbe essere impostato su una maschera di bit delle chiavi per le modifiche che l'utente sta premendo.

LoadURL

void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie in cui caricare questo URL.
pchURLconst char *L'URL da caricare.
pchPostDataconst char *Invia opzionalmente una richiesta POST con questi dati. Imposta su NULL per non inviare alcun dato.

Naviga all'URL specificato.

Se inviti dati POST con pchPostData, dovrebbero essere formattati come: name1=value1&name2=value2.

Puoi caricare qualunque schema URI supportato dal Chromium Embedded Framework, tra cui: http://, https://, ftp:// e file:///. Se non viene specificato alcuno schema, verrà usato http://.

Restituisce: void
Attiva una callback HTML_StartRequest_t.

MouseDoubleClick

void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
eMouseButtonEHTMLMouseButtonIl pulsante del mouse con cui si è fatto doppio clic.

Informa una superficie HTML che è stato fatto doppio clic con un pulsante del mouse.

Il clic avverrà dove la superficie immagina che si trovi il mouse, in base alla chiamata più recente a MouseMove.

MouseDown

void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
eMouseButtonEHTMLMouseButtonIl pulsante del mouse che è stato premuto.

Informa una superficie HTML che è stato premuto un pulsante del mouse.

Il clic avverrà dove la superficie immagina che si trovi il mouse, in base alla chiamata più recente a MouseMove.

MouseMove

void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
xintCoordinata X (larghezza) in pixel relativa alla posizione della superficie HTML. (0, 0) è l'angolo in alto a sinistra.
yintCoordinata Y (altezza) in pixel relativa alla posizione della superficie HTML. (0, 0) è l'angolo in alto a sinistra.

Informa una superficie HTML su dove si trovi il mouse.

MouseUp

void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
eMouseButtonEHTMLMouseButtonIl pulsante del mouse che è stato rilasciato.

Informa una superficie HTML che è stato rilasciato un pulsante del mouse.

Il clic avverrà dove la superficie immagina che si trovi il mouse, in base alla chiamata più recente a MouseMove.

MouseWheel

void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie a cui inviare l'interazione.
nDeltaint32Il numero di pixel da scorrere.

Informa una superficie HTML che è stata mossa la rotellina del mouse.

PasteFromClipboard

void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie in cui copiare.

Copia dagli appunti locali alla pagina corrente di una superficie HTML.

Reload

void Reload( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie da ricaricare.

Ricarica la pagina corrente.

Per farlo, verrà probabilmente utilizzata la cache locale invece che la rete. Equivale a premere F5 o CTRL+R sul tuo browser.

RemoveBrowser

void RemoveBrowser( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle del browser da rilasciare.

DEVI effettuare questa chiamata quando hai finito di usare una superficie HTML, in modo da rilasciare le risorse associate.

Non farlo risulterà in una perdita di memoria!

SetBackgroundMode

void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie su cui impostare la modalità background.
bBackgroundModeboolAttiva o disattiva la modalità background.

Abilita/disabilità la modalità a basso consumo background, in cui i timer di javascript e di renderizzazione sono rallentati, le risorse sono rimosse più aggressivamente dalla memoria e gli elementi audio/video vengono messi in pausa.

Quando la modalità background è abilitata, tutti gli oggetti video e audio HTML5 eseguiranno ".pause()" e avranno la proprietà "._steam_background_paused = 1".
Quando la modalità background è disabilitata, gli oggetti video e audio con quella proprietà riprenderanno con ".play()".

SetCookie

void SetCookie( const char *pchHostname, const char *pchKey, const char *pchValue, const char *pchPath = "/", RTime32 nExpires = 0, bool bSecure = false, bool bHTTPOnly = false );
NomeTipoDescrizione
pchHostnameconst char *L'hostname del server per cui impostare il cookie (attributo "host").
pchKeyconst char *Il nome del cookie da impostare.
pchValueconst char *Il valore del cookie da impostare.
pchPathconst char *Imposta l'attributo "path" sul cookie. Puoi usarlo per limitare il cookie a un percorso specifico sul dominio, ad esempio "/accounts".
nExpiresRTime32Imposta l'attributo "Expires" sul cookie sul timestamp specificato in formato epoch Unix (in secondi a partire dal 1 gennaio 1970).
bSecureboolImposta l'attributo "Secure".
bHTTPOnlyboolImposta l'attributo "HttpOnly".

Imposta una cookie web per uno specifico hostname.

Maggiori informazioni sull'impostazione dei cookie sono disponibili su wikipedia.

SetHorizontalScroll

void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie su cui impostare la posizione di scorrimento orizzontale.
nAbsolutePixelScrolluint32La posizione assoluta dei pixel verso cui scorrere. 0 è il lato sinistro e HTML_HorizontalScroll_t.unScrollMax è il lato destro.

Scorre orizzontalmente la pagina corrente.

Restituisce: void
Attiva una callback HTML_HorizontalScroll_t.


Vedi anche: HTML_HorizontalScroll_t, SetVerticalScroll, HTML_VerticalScroll_t

SetKeyFocus

void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie da rendere selezionabile da tasti.
bHasKeyFocusboolSelezionabile da tasti o no?

Informa una superficie HTML se sia al momento selezionabile da tasti. Fra le altre cose, controlla la visualizzazione del cursore I-beam nei controlli di testo.

SetPageScaleFactor

void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie da ridimensionare.
flZoomfloatL'ammontare dello zoom, compreso tra 1 (100% e il valore predefinito) e 2 (200%).
nPointXintIl punto X in pixel attorno a cui zoomare. Usa 0 se non ti interessa.
nPointYintIl punto Y in pixel attorno a cui zoomare. Usa 0 se non ti interessa.

Ingrandisce la pagina corrente in una superficie HTML.

Il fattore di ridimensionamento corrente è disponibile da HTML_NeedsPaint_t.flPageScale, HTML_HorizontalScroll_t.flPageScale e HTML_VerticalScroll_t.flPageScale.

SetSize

void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie di cui impostare le dimensioni.
unWidthuint32La larghezza in pixel della superficie.
unHeightuint32L'altezza in pixel della superficie.

Imposta le dimensioni di visualizzazione in pixel di una superficie.

SetVerticalScroll

void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie su cui impostare la posizione di scorrimento verticale.
nAbsolutePixelScrolluint32La posizione assoluta dei pixel verso cui scorrere. 0 è in cima e HTML_VerticalScroll_t.unScrollMax è in fondo.

Scorre verticalmente la pagina corrente.

Restituisce: void
Attiva una callback HTML_VerticalScroll_t.


Vedi anche: HTML_VerticalScroll_t, SetHorizontalScroll, HTML_HorizontalScroll_t

Shutdown

bool Shutdown();
Arresta l'interfaccia ISteamHTMLSurface, liberando la memoria e gli handle.

DEVI effettuare questa chiamata quando hai finito di usare questa interfaccia, in modo da prevenire perdite di memoria e di handle. Dopo aver effettuato questa chiamata, tutte le funzioni di questa interfaccia falliranno finché non chiamerai Init per inizializzarla di nuovo.

Restituisce: bool
Al momento, questa funzione restituisce sempre true.

StopFind

void StopFind( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie in cui interrompere la ricerca di risultati.

Annulla una ricerca di risultati in corso.

Vedi anche: Find

StopLoad

void StopLoad( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie di cui interrompere il caricamento.

Interrompe il caricamento della pagina HTML corrente.

ViewSource

void ViewSource( HHTMLBrowser unBrowserHandle );
NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie di cui visualizzare la sorgente corrente della pagina.

Apre il codice sorgente delle pagine HTML attuali nell'editor di testo locale predefinito. Utilizzato per il debugging.

Callback

Queste sono callback che possono essere attivate chiamando SteamAPI_RunCallbacks. Molte di esse saranno attivate direttamente in risposta alle funzioni membro di ISteamHTMLSurface.

HTML_BrowserReady_t

Un nuovo browser è stato creato ed è pronto all'uso.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserQuesto è l'handle al browser appena creato. Puoi usarlo per le chiamate future a ISteamHTMLSurface.

Funzioni associate: CreateBrowser

HTML_CanGoBackAndForward_t

Chiamata quando lo stato della cronologia della pagina ha modificato la capacità di andare indietro e avanti.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
bCanGoBackboolRestituisce se è possibile navigare indietro.
bCanGoForwardboolRestituisce se è possibile navigare avanti.

HTML_ChangedTitle_t

Chiamata quando la pagina corrente in un browser ottiene un nuovo titolo.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchTitleconst char *Il nuovo titolo della pagina.

HTML_CloseBrowser_t

Chiamata quando al browser è stato richiesto di chiudersi per via di un'interazione da parte dell'utente, solitamente per via di una chiamata window.close() a javascript.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.

HTML_FileOpenDialog_t

Chiamata quando una superficie del browser ha ricevuto una finestra di dialogo per aprire un file da un <input type="file"> click o un'azione simile. Dovrai chiamare FileLoadDialogResponse con il file o i file che l'utente ha selezionato.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che si sta navigando.
pchTitleconst char *Il nome del dialogo (ad esempio "Carica immagini").
pchInitialFileconst char *Il nome del file che la pagina vuole che imposti come predefinito. Potrebbe aspettarsi un file con quel nome, o che si tratti di un file caricato in precedenza dall'utente.

HTML_FinishedRequest_t

Chiamata quando un browser ha finito di caricare una pagina.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa chiamata.
pchURLconst char *L'URL che è stato caricato.
pchPageTitleconst char *Il titolo della pagina che è stata caricata.

HTML_HideToolTip_t

Chiamata quando un browser vuole nascondere un suggerimento.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.

HTML_HorizontalScroll_t

Fornisce dettagli sulla visibilità e le dimensioni della barra di scorrimento orizzontale.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
unScrollMaxuint32Il valore massimo di scorrimento orizzontale.
unScrollCurrentuint32La posizione corrente di scorrimento orizzontale.
flPageScalefloatLe dimensioni correnti della pagina.
bVisibleboolSe la barra di scorrimento orizzontale è visibile.
unPageSizeuint32La larghezza totale della pagina in pixel.

Funzioni associate: SetHorizontalScroll

HTML_JSAlert_t

Chiamata quando il browser vuole visualizzare una finestra di allerta javascript. Quando l'utente chiude la finestra, chiama JSDialogResponse (che puoi anche chiamare immediatamente per ignorarla).

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa chiamata.
pchMessageconst char *Il messaggio associato al dialogo.

HTML_JSConfirm_t

Chiamata quando il browser vuole visualizzare una finestra di conferma javascript. Quando l'utente chiude la finestra, chiama JSDialogResponse (che puoi anche chiamare immediatamente per ignorarla).

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa chiamata.
pchMessageconst char *Il messaggio associato al dialogo.

HTML_LinkAtPosition_t

Risultato di una chiamata a GetLinkAtPosition

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa chiamata.
xuint32Non utilizzato.
yuint32Non utilizzato.
pchURLconst char *L'URL trovato in questa posizione. NULL se non è stato trovato un collegamento.
bInputboolLa posizione era un campo di input?
bLiveLinkbool

Funzioni associate: GetLinkAtPosition

HTML_NeedsPaint_t

Chiamata quando un browser ha una richiesta di renderizzazione in sospeso. Qui otterrai i dati effettivi dell'immagine da renderizzare sullo schermo.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pBGRAconst char *Un puntatore ai dati B8G8R8A8 dell'immagine per questa superficie, valido fino alla chiamata a SteamAPI_RunCallbacks.
unWideuint32La larghezza totale della texture pBGRA.
unTalluint32L'altezza totale della texture pBGRA.
unUpdateXuint32Lo scostamento su X del rettangolo su cui ha effetto questo aggiornamento.
unUpdateYuint32Lo scostamento su Y del rettangolo su cui ha effetto questo aggiornamento.
unUpdateWideuint32La larghezza del rettangolo su cui ha effetto questo aggiornamento.
unUpdateTalluint32L'altezza del rettangolo su cui ha effetto questo aggiornamento.
unScrollXuint32La posizione di scorrimento orizzontale in cui si trovava il browser quando è stata renderizzata questa texture.
unScrollYuint32La posizione di scorrimento verticale in cui si trovava il browser quando è stata renderizzata questa texture.
flPageScalefloatIl fattore di ridimensionamento in cui si trovava il browser quando è stata renderizzata questa texture.
unPageSerialuint32Incrementa a ogni caricamento della pagina. Puoi usarlo per rifiutare modifiche mentre apri nuove pagine.

HTML_NewWindow_t

Un browser ha creato una nuova finestra HTML.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchURLconst char *L'URL da caricare nella nuova finestra.
unXuint32La posizione X nella pagina in cui mostrare la finestra di notifica.
unYuint32La posizione Y nella pagina in cui mostrare la finestra di notifica.
unWideuint32La larghezza totale della texture pBGRA.
unTalluint32L'altezza totale della texture pBGRA.
unNewWindow_BrowserHandleHHTMLBrowserL'handle della superficie della nuova finestra.

HTML_OpenLinkInNewTab_t

Il browser ha richiesto di caricare un URL in una nuova scheda.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchURLconst char *L'URL che il browser vuole caricare.

HTML_SearchResults_t

Risultati di una ricerca.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
unResultsuint32Il numero di risultati corrispondenti trovati.
unCurrentMatchuint32L'ordinale della corrispondenza corrente relativa a unResults.

Funzioni associate: Find

HTML_SetCursor_t

Chiamata quando un browser vuole modificare il cursore del mouse.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
eMouseCursoruint32Il EMouseCursor da visualizzare.

HTML_ShowToolTip_t

Chiamata quando un browser vuole visualizzare una finestra di suggerimento.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchMsgconst char *Il testo della finestra di suggerimento che vuole essere visualizzata.

HTML_StartRequest_t

Chiamata quando un browser vuole aprire una nuova pagina.
NOTA: DEVI chiamare AllowStartRequest in risposta a questa callback!

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie che si sta navigando.
pchURLconst char *L'URL a cui si vuole dirigere.
pchTargetconst char *Il tipo di target del collegamento HTML (ad esempio _blank, _self, _parent, _top ).
pchPostDataconst char *Qualunque dato inviato per la richiesta.
bIsRedirectbool"True" se si tratta di un ridirezionamento http/html dalla precedente richiesta di caricamento.

Funzioni associate: LoadURL

HTML_StatusText_t

Chiamata quando un browser vuole che visualizzi un messaggio di informazione. Usato di solito quando si passa sopra un collegamento con il mouse.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchMsgconst char *Il testo del messaggio di stato da visualizzare.

HTML_UpdateToolTip_t

Chiamata quando il testo di una finestra di suggerimento esistente è stato aggiornato.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchMsgconst char *Il nuovo testo del messaggio di suggerimento.

HTML_URLChanged_t

Chiamata quando il browser si reca a un nuovo URL.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
pchURLconst char *L'URL a cui il browser si sta recando.
pchPostDataconst char *Qualunque dato inviato per la richiesta, NULL se non ne è stato inviato alcuno.
bIsRedirectbooltrue se si trattava di un ridirezionamento http/html dalla precedente richiesta di caricamento, altrimenti false.
pchPageTitleconst char *Il titolo della pagina.
bNewNavigationboolTrue se la pagina è cambiata, invece che avere eseguito una chiamata all'API della cronologia del browser.

HTML_VerticalScroll_t

Fornisce dettagli sulla visibilità e le dimensioni della barra di scorrimento verticale.

NomeTipoDescrizione
unBrowserHandleHHTMLBrowserL'handle della superficie relativo a questa callback.
unScrollMaxuint32Il valore massimo di scorrimento verticale.
unScrollCurrentuint32La posizione corrente di scorrimento verticale.
flPageScalefloatLe dimensioni correnti della pagina.
bVisibleboolSe la barra di scorrimento verticale è visibile.
unPageSizeuint32L'altezza totale della pagina in pixel.

Funzioni associate: SetVerticalScroll

Enums

Queste sono le enumerazioni definite per l'utilizzo con ISteamHTMLSurface.

EHTMLKeyModifiers

Usata per informare il browser di quali pulsanti sono premuti con KeyChar, KeyUp e KeyDown. Questi contrassegni possono essere aggiunti insieme utilizzando l'operatore bit a bit OR.

NomeValoreDescrizione
k_eHTMLKeyModifier_None0Non è premuto alcun modificatore.
k_eHTMLKeyModifier_AltDown1 << 0Uno dei tasti ALT è premuto.
k_eHTMLKeyModifier_CtrlDown1 << 1Uno dei tasti CTRL è premuto.
k_eHTMLKeyModifier_ShiftDown1 << 2Uno dei tasti SHIFT è premuto.

EHTMLMouseButton

Usata per informare il browser di quando viene premuto un pulsante del mouse con: MouseUp, MouseDown e MouseDoubleClick.

NomeValoreDescrizione
eHTMLMouseButton_Left0Il pulsante sinistro è premuto.
eHTMLMouseButton_Right1Il pulsante destro è premuto.
eHTMLMouseButton_Middle2Il pulsante centrale è premuto.

EMouseCursor

Elenca i puntatori del mouse che la superficie HTML ti chiederà di renderizzare.

NomeValoreDescrizione
dc_user0
dc_none1
dc_arrow2
dc_ibeam3
dc_hourglass4
dc_waitarrow5
dc_crosshair6
dc_up7
dc_sizenw8
dc_sizese9
dc_sizene10
dc_sizesw11
dc_sizew12
dc_sizee13
dc_sizen14
dc_sizes15
dc_sizewe16
dc_sizens17
dc_sizeall18
dc_no19
dc_hand20
dc_blank21Non mostrare un cursore personalizzato, usa quello predefinito.
dc_middle_pan22
dc_north_pan23
dc_north_east_pan24
dc_east_pan25
dc_south_east_pan26
dc_south_pan27
dc_south_west_pan28
dc_west_pan29
dc_north_west_pan30
dc_alias31
dc_cell32
dc_colresize33
dc_copycur34
dc_verticaltext35
dc_rowresize36
dc_zoomin37
dc_zoomout38
dc_help39
dc_custom40
dc_last41Usato solo per scorrere tra tutti i cursori. I cursori personalizzati iniziano a partire da questo valore.

Typedefs

Queste sono typedef definite per l'utilizzo con ISteamHTMLSurface.

NomeTipo baseDescrizione
HHTMLBrowseruint32Rappresenta un handle unico per una superficie HTML.

Costanti

Queste sono costanti definite per l'utilizzo con ISteamHTMLSurface.

NomeTipoValoreDescrizione
INVALID_HTMLBROWSERuint320Indica che un handle del browser non è valido. Dovresti inizializzare i tuoi handle HHTMLBrowser con questo valore e poi riportarlo indietro quando la pagina si chiude.
STEAMHTMLSURFACE_INTERFACE_VERSIONconst char *"STEAMHTMLSURFACE_INTERFACE_VERSION_003"