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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie su cui aggiungere l'intestazione. |
pchKey | const char * | Il nome dell'intestazione da aggiungere. |
pchValue | const 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che si sta navigando. |
bAllowed | bool | Consente o rifiuta la navigazione alla richiesta di inizio corrente. |
Imposta se un caricamento in sospeso è consentito o se deve essere annullato.
Puoi usare questa funzionalità per limitare le pagine valide consentite sulla tua superficie HTML.
CopyToClipboard
void CopyToClipboard( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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 );
Nome | Tipo | Descrizione |
pchUserAgent | const 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. |
pchUserCSS | const 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.
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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che si sta navigando. |
pchScript | const char * | Lo javascript da eseguire. |
Esegue uno javascript nella pagina attualmente caricata.
FileLoadDialogResponse
void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che vuole fare apparire una finestra di notifica per aprire un file. |
pchSelectedFiles | const 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.
Find
void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie in cui trovare la stringa. |
pchSearchStr | const char * | La stringa da cercare. |
bCurrentlyInFind | bool | Imposta su true sulle chiamate successive per scorrere fino alla stringa seguente corrispondente. |
bReverse | bool | Inizia 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie da cui ottenere un link. |
x | int | La posizione X (larghezza) in pixel all'interno della superficie. (0, 0) è l'angolo in alto a sinistra. |
y | int | La 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui tornare. |
Torna indietro nella cronologia della pagina.
GoForward
void GoForward( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che sta facendo apparire una finestra di dialogo. |
bResult | bool | Imposta 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.
KeyChar
void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
cUnicodeChar | uint32 | Il punto del carattere unicode del tasto premuto. Potrebbe corrispondere a più di un carattere per pressione. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dovrebbe 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
nNativeKeyCode | uint32 | Il valore del codice tasto virtuale proveniente dal sistema operativo. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dovrebbe 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
nNativeKeyCode | uint32 | Il valore del codice tasto virtuale proveniente dal sistema operativo. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dovrebbe 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie in cui caricare questo URL. |
pchURL | const char * | L'URL da caricare. |
pchPostData | const 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
eMouseButton | EHTMLMouseButton | Il 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
eMouseButton | EHTMLMouseButton | Il 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
x | int | Coordinata X (larghezza) in pixel relativa alla posizione della superficie HTML. (0, 0) è l'angolo in alto a sinistra. |
y | int | Coordinata 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
eMouseButton | EHTMLMouseButton | Il 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie a cui inviare l'interazione. |
nDelta | int32 | Il numero di pixel da scorrere. |
Informa una superficie HTML che è stata mossa la rotellina del mouse.
PasteFromClipboard
void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie in cui copiare. |
Copia dagli appunti locali alla pagina corrente di una superficie HTML.
Reload
void Reload( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie su cui impostare la modalità background. |
bBackgroundMode | bool | Attiva 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 );
Nome | Tipo | Descrizione |
pchHostname | const char * | L'hostname del server per cui impostare il cookie (attributo "host"). |
pchKey | const char * | Il nome del cookie da impostare. |
pchValue | const char * | Il valore del cookie da impostare. |
pchPath | const char * | Imposta l'attributo "path" sul cookie. Puoi usarlo per limitare il cookie a un percorso specifico sul dominio, ad esempio "/accounts". |
nExpires | RTime32 | Imposta l'attributo "Expires" sul cookie sul timestamp specificato in formato epoch Unix (in secondi a partire dal 1 gennaio 1970). |
bSecure | bool | Imposta l'attributo "Secure". |
bHTTPOnly | bool | Imposta 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie su cui impostare la posizione di scorrimento orizzontale. |
nAbsolutePixelScroll | uint32 | La 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_tSetKeyFocus
void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie da rendere selezionabile da tasti. |
bHasKeyFocus | bool | Selezionabile 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie da ridimensionare. |
flZoom | float | L'ammontare dello zoom, compreso tra 1 (100% e il valore predefinito) e 2 (200%). |
nPointX | int | Il punto X in pixel attorno a cui zoomare. Usa 0 se non ti interessa. |
nPointY | int | Il 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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie di cui impostare le dimensioni. |
unWidth | uint32 | La larghezza in pixel della superficie. |
unHeight | uint32 | L'altezza in pixel della superficie. |
Imposta le dimensioni di visualizzazione in pixel di una superficie.
SetVerticalScroll
void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie su cui impostare la posizione di scorrimento verticale. |
nAbsolutePixelScroll | uint32 | La 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_tShutdown
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 );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie in cui interrompere la ricerca di risultati. |
Annulla una ricerca di risultati in corso.
Vedi anche: FindStopLoad
void StopLoad( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie di cui interrompere il caricamento. |
Interrompe il caricamento della pagina HTML corrente.
ViewSource
void ViewSource( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | Questo è l'handle al browser appena creato. Puoi usarlo per le chiamate future a ISteamHTMLSurface. |
Funzioni associate: CreateBrowserHTML_CanGoBackAndForward_t
Chiamata quando lo stato della cronologia della pagina ha modificato la capacità di andare indietro e avanti.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
bCanGoBack | bool | Restituisce se è possibile navigare indietro. |
bCanGoForward | bool | Restituisce se è possibile navigare avanti. |
HTML_ChangedTitle_t
Chiamata quando la pagina corrente in un browser ottiene un nuovo titolo.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchTitle | const 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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che si sta navigando. |
pchTitle | const char * | Il nome del dialogo (ad esempio "Carica immagini"). |
pchInitialFile | const 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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa chiamata. |
pchURL | const char * | L'URL che è stato caricato. |
pchPageTitle | const char * | Il titolo della pagina che è stata caricata. |
HTML_HideToolTip_t
Chiamata quando un browser vuole nascondere un suggerimento.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
HTML_HorizontalScroll_t
Fornisce dettagli sulla visibilità e le dimensioni della barra di scorrimento orizzontale.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
unScrollMax | uint32 | Il valore massimo di scorrimento orizzontale. |
unScrollCurrent | uint32 | La posizione corrente di scorrimento orizzontale. |
flPageScale | float | Le dimensioni correnti della pagina. |
bVisible | bool | Se la barra di scorrimento orizzontale è visibile. |
unPageSize | uint32 | La larghezza totale della pagina in pixel. |
Funzioni associate: SetHorizontalScrollHTML_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).
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa chiamata. |
pchMessage | const 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).
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa chiamata. |
pchMessage | const char * | Il messaggio associato al dialogo. |
HTML_LinkAtPosition_t
Risultato di una chiamata a
GetLinkAtPosition Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa chiamata. |
x | uint32 | Non utilizzato. |
y | uint32 | Non utilizzato. |
pchURL | const char * | L'URL trovato in questa posizione. NULL se non è stato trovato un collegamento. |
bInput | bool | La posizione era un campo di input? |
bLiveLink | bool | |
Funzioni associate: GetLinkAtPositionHTML_NeedsPaint_t
Chiamata quando un browser ha una richiesta di renderizzazione in sospeso. Qui otterrai i dati effettivi dell'immagine da renderizzare sullo schermo.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pBGRA | const char * | Un puntatore ai dati B8G8R8A8 dell'immagine per questa superficie, valido fino alla chiamata a SteamAPI_RunCallbacks. |
unWide | uint32 | La larghezza totale della texture pBGRA . |
unTall | uint32 | L'altezza totale della texture pBGRA . |
unUpdateX | uint32 | Lo scostamento su X del rettangolo su cui ha effetto questo aggiornamento. |
unUpdateY | uint32 | Lo scostamento su Y del rettangolo su cui ha effetto questo aggiornamento. |
unUpdateWide | uint32 | La larghezza del rettangolo su cui ha effetto questo aggiornamento. |
unUpdateTall | uint32 | L'altezza del rettangolo su cui ha effetto questo aggiornamento. |
unScrollX | uint32 | La posizione di scorrimento orizzontale in cui si trovava il browser quando è stata renderizzata questa texture. |
unScrollY | uint32 | La posizione di scorrimento verticale in cui si trovava il browser quando è stata renderizzata questa texture. |
flPageScale | float | Il fattore di ridimensionamento in cui si trovava il browser quando è stata renderizzata questa texture. |
unPageSerial | uint32 | Incrementa 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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchURL | const char * | L'URL da caricare nella nuova finestra. |
unX | uint32 | La posizione X nella pagina in cui mostrare la finestra di notifica. |
unY | uint32 | La posizione Y nella pagina in cui mostrare la finestra di notifica. |
unWide | uint32 | La larghezza totale della texture pBGRA. |
unTall | uint32 | L'altezza totale della texture pBGRA. |
unNewWindow_BrowserHandle | HHTMLBrowser | L'handle della superficie della nuova finestra. |
HTML_OpenLinkInNewTab_t
Il browser ha richiesto di caricare un URL in una nuova scheda.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchURL | const char * | L'URL che il browser vuole caricare. |
HTML_SearchResults_t
Risultati di una ricerca.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
unResults | uint32 | Il numero di risultati corrispondenti trovati. |
unCurrentMatch | uint32 | L'ordinale della corrispondenza corrente relativa a unResults . |
Funzioni associate: FindHTML_SetCursor_t
Chiamata quando un browser vuole modificare il cursore del mouse.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
eMouseCursor | uint32 | Il EMouseCursor da visualizzare. |
HTML_ShowToolTip_t
Chiamata quando un browser vuole visualizzare una finestra di suggerimento.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchMsg | const char * | Il testo della finestra di suggerimento che vuole essere visualizzata. |
HTML_StartRequest_t
Chiamata quando un browser vuole aprire una nuova pagina.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie che si sta navigando. |
pchURL | const char * | L'URL a cui si vuole dirigere. |
pchTarget | const char * | Il tipo di target del collegamento HTML (ad esempio _blank, _self, _parent, _top ). |
pchPostData | const char * | Qualunque dato inviato per la richiesta. |
bIsRedirect | bool | "True" se si tratta di un ridirezionamento http/html dalla precedente richiesta di caricamento. |
Funzioni associate: LoadURLHTML_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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchMsg | const char * | Il testo del messaggio di stato da visualizzare. |
HTML_UpdateToolTip_t
Chiamata quando il testo di una finestra di suggerimento esistente è stato aggiornato.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchMsg | const char * | Il nuovo testo del messaggio di suggerimento. |
HTML_URLChanged_t
Chiamata quando il browser si reca a un nuovo URL.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
pchURL | const char * | L'URL a cui il browser si sta recando. |
pchPostData | const char * | Qualunque dato inviato per la richiesta, NULL se non ne è stato inviato alcuno. |
bIsRedirect | bool | true se si trattava di un ridirezionamento http/html dalla precedente richiesta di caricamento, altrimenti false. |
pchPageTitle | const char * | Il titolo della pagina. |
bNewNavigation | bool | True 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.
Nome | Tipo | Descrizione |
unBrowserHandle | HHTMLBrowser | L'handle della superficie relativo a questa callback. |
unScrollMax | uint32 | Il valore massimo di scorrimento verticale. |
unScrollCurrent | uint32 | La posizione corrente di scorrimento verticale. |
flPageScale | float | Le dimensioni correnti della pagina. |
bVisible | bool | Se la barra di scorrimento verticale è visibile. |
unPageSize | uint32 | L'altezza totale della pagina in pixel. |
Funzioni associate: SetVerticalScrollEnums
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.
Nome | Valore | Descrizione |
k_eHTMLKeyModifier_None | 0 | Non è premuto alcun modificatore. |
k_eHTMLKeyModifier_AltDown | 1 << 0 | Uno dei tasti ALT è premuto. |
k_eHTMLKeyModifier_CtrlDown | 1 << 1 | Uno dei tasti CTRL è premuto. |
k_eHTMLKeyModifier_ShiftDown | 1 << 2 | Uno dei tasti SHIFT è premuto. |
EHTMLMouseButton
Usata per informare il browser di quando viene premuto un pulsante del mouse con:
MouseUp,
MouseDown e
MouseDoubleClick.
Nome | Valore | Descrizione |
eHTMLMouseButton_Left | 0 | Il pulsante sinistro è premuto. |
eHTMLMouseButton_Right | 1 | Il pulsante destro è premuto. |
eHTMLMouseButton_Middle | 2 | Il pulsante centrale è premuto. |
EMouseCursor
Elenca i puntatori del mouse che la superficie HTML ti chiederà di renderizzare.
Nome | Valore | Descrizione |
dc_user | 0 | |
dc_none | 1 | |
dc_arrow | 2 | |
dc_ibeam | 3 | |
dc_hourglass | 4 | |
dc_waitarrow | 5 | |
dc_crosshair | 6 | |
dc_up | 7 | |
dc_sizenw | 8 | |
dc_sizese | 9 | |
dc_sizene | 10 | |
dc_sizesw | 11 | |
dc_sizew | 12 | |
dc_sizee | 13 | |
dc_sizen | 14 | |
dc_sizes | 15 | |
dc_sizewe | 16 | |
dc_sizens | 17 | |
dc_sizeall | 18 | |
dc_no | 19 | |
dc_hand | 20 | |
dc_blank | 21 | Non mostrare un cursore personalizzato, usa quello predefinito. |
dc_middle_pan | 22 | |
dc_north_pan | 23 | |
dc_north_east_pan | 24 | |
dc_east_pan | 25 | |
dc_south_east_pan | 26 | |
dc_south_pan | 27 | |
dc_south_west_pan | 28 | |
dc_west_pan | 29 | |
dc_north_west_pan | 30 | |
dc_alias | 31 | |
dc_cell | 32 | |
dc_colresize | 33 | |
dc_copycur | 34 | |
dc_verticaltext | 35 | |
dc_rowresize | 36 | |
dc_zoomin | 37 | |
dc_zoomout | 38 | |
dc_help | 39 | |
dc_custom | 40 | |
dc_last | 41 | Usato 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.
Nome | Tipo base | Descrizione |
HHTMLBrowser | uint32 | Rappresenta un handle unico per una superficie HTML. |
Costanti
Queste sono costanti definite per l'utilizzo con ISteamHTMLSurface.
Nome | Tipo | Valore | Descrizione |
INVALID_HTMLBROWSER | uint32 | 0 | Indica 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_VERSION | const char * | "STEAMHTMLSURFACE_INTERFACE_VERSION_003" | |