Grænseflade til at gengive og interagere med HTML-sider.
Du kan bruge denne grænseflade til at gengive og vise HTML-sider direkte i dit spil eller din applikation. Du skal kalde
Init, før du bruger denne grænseflade, og
Shutdown, når du er færdig med at bruge den.
Det er bygget på den Chromium-integrerede ramme og understøtter HTML5 markup.
Se
Steam-HTML-overflade for at få yderligere oplysninger.
Medlemsfunktioner
Medlemsfunktioner for
ISteamHTMLSurface
kaldes gennem den globale accessor-funktion
SteamHTMLSurface()
.
AddHeader
void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der skal tilføjes en overskrift til. |
pchKey | const char * | Overskriftens navn, som skal tilføjes. |
pchValue | const char * | Overskriftsværdier, som skal tilknyttes med nøglen. |
Tilføj en overskrift til enhver HTTP-anmodning fra denne browser.
En fuldstændig liste over standardanmodninger er tilgængelig her på
wikipedia.
AllowStartRequest
void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som navigerer. |
bAllowed | bool | Tillad eller nægt navigation til den aktuelle startanmodning. |
Indstiller, om en afventende indlæsning er tilladt, eller om den skal annulleres.
Du kan bruge denne funktion til at begrænse gyldige sider, som er tilladt i din HTML-overflade.
CopyToClipboard
void CopyToClipboard( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der skal kopieres tekst fra. |
Kopier den aktuelt valgte tekst fra den aktuelle side i en HTML-overflade til den lokale udklipsholder.
CreateBrowser
SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );
Navn | Type | Beskrivelse |
pchUserAgent | const char * | Tilføjer strengen til browserens generelle brugeragentstreng, så du kan registrere din klient på webservere. Brug NULL, hvis du ikke påkræver denne funktionalitet. |
pchUserCSS | const char * | Dette tillader dig at indstille en CSS-stil til hver side, som vises af denne browser. Brug NULL, hvis du ikke påkræver denne funktionalitet. |
Opret et browserobjekt til visning af en HTML-side.
Du skal kalde
SetSize og
LoadURL for at begynde at bruge din displayoverflade.
Returværdier: SteamAPICall_t, som skal bruges med et
HTML_BrowserReady_t-kaldsresultat.
ExecuteJavascript
void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som navigerer. |
pchScript | const char * | JavaScript-scriptet, som skal køres. |
Kør et JavaScript-script på den aktuelt indlæste side.
FileLoadDialogResponse
void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som ønsker at fremkalde en åben fildialogboks. |
pchSelectedFiles | const char ** | Dette bør være et array med absolutte filstier til filerne, som brugeren har valgt. NULL, hvis brugeren ikke valgte nogen filer. |
Giver dig mulighed for at reagere på en side, der ønsker at åbne en filindlæsningsdialogboks.
Find
void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, strengen skal findes i. |
pchSearchStr | const char * | Strengen, som der skal søges efter. |
bCurrentlyInFind | bool | Sæt denne til true på efterfølgende kald for at gå til den næste matchende streng. |
bReverse | bool | Søg fra bunden og op? |
Find en streng på den aktuelle side af en HTML-overflade.
Dette svarer til "Ctrl+F" i din valgte browser. Det vil fremhæve alle de matchende strenge.
Du bør kalde
StopFind, når inputstrengen er ændret, eller du ønsker at stoppe med at søge.
Returværdier: void
Udløser et
HTML_SearchResults_t-tilbagekald.
GetLinkAtPosition
void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der hentes link fra. |
x | int | X-position (bredde) i pixels indenfor overfladen. (0, 0) er det øverste venstre hjørne. |
y | int | Y-position (højde) i pixels indenfor overfladen. (0, 0) er det øverste venstre hjørne. |
Henter detaljer om et link i en bestemt position på den aktuelle side i en HTML-overflade.
Returværdier: void
Udløser et
HTML_LinkAtPosition_t-tilbagekald.
GoBack
void GoBack( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der skal navigeres tilbage til. |
Naviger tilbage i sidehistorikken.
GoForward
void GoForward( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der skal navigeres frem til. |
Naviger frem i sidehistorikken
Init
bool Init();
Initialiserer HTML-overflade-API'en.
Dette skal kaldes inden brug af andre funktioner i denne grænseflade.
Du skal kalde
Shutdown, når du er færdig, ved hjælp af brugergrænsefladen for at frigøre de ressourcer, der er forbundet med det. Hvis du undlader at gøre det, vil det medføre hukommelsesfejl!
Returværdier: bool
true, hvis API'en er påbegyndt, ellers
false.
JSDialogResponse
void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som fremkalder en dialogboks. |
bResult | bool | Angiv denne til true for at simulere et tryk på "OK"-knappen, ellers false for "Annuller". |
Giver dig mulighed for at reagere på en side, som ønsker at åbne en notifikation om en JavaScript-modaldialogboks.
KeyChar
void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
cUnicodeChar | uint32 | Tegnpunktet i Unicode-format for dette tastetryk og potentielt flere tegn pr. tryk. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dette bør indstilles til en bitmaske tilhørende modificeringsnøgler, som brugeren i øjeblikket trykker på. |
cUnicodeChar er tegnpunktet i Unicode-format for dette tastetryk (og potentielt flere tegn pr. tryk)
KeyDown
void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
nNativeKeyCode | uint32 | Dette er den virtuelle nøglekodeværdi fra operativsystemet. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dette bør indstilles til en bitmaske tilhørende modificeringsnøgler, som brugeren i øjeblikket trykker på. |
Tastaturinteraktioner, indbygget nøglekode er den virtuelle nøglekodeværdi for dit OS
KeyUp
void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
nNativeKeyCode | uint32 | Dette er den virtuelle nøglekodeværdi fra operativsystemet. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Dette bør indstilles til en bitmaske tilhørende modificeringsnøgler, som brugeren i øjeblikket trykker på. |
LoadURL
void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som denne URL skal indlæses i. |
pchURL | const char * | URL'en, som skal loades. |
pchPostData | const char * | Send eventuelt en POST-anmodning med disse data, angiv dette til NULL for ikke at sende data. |
Naviger til en angivet URL.
Hvis du sender POST data med
pchPostData
, så bør dataene være formateret som:
name1=value1&name2=value2
.
Du kan indlæse alle URI-ordninger understøttet af Chromium Embedded Framework, herunder (men ikke begrænset til):
http://
,
https://
,
ftp://
og
file:///
. Hvis der ikke er angivet nogen ordninger, bruges
http://
.
Returværdier: void
Udløser et
HTML_StartRequest_t-tilbagekald.
MouseDoubleClick
void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
eMouseButton | EHTMLMouseButton | Museknappen, som der blev dobbeltklikket med. |
Fortæller en HTML-overflade, at der er blevet dobbeltklikket på en museknap.
Klikket vil opstå, hvor overfladen tror, at musen er, baseret på det seneste kald til
MouseMove.
MouseDown
void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
eMouseButton | EHTMLMouseButton | Museknappen, der blev trykket på. |
Fortæller en HTML-overflade, at der er blevet trykket på en museknap.
Klikket vil opstå, hvor overfladen tror, at musen er, baseret på det seneste kald til
MouseMove.
MouseMove
void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
x | int | X-koordinat (bredde) i pixels i forhold til placeringen af HTML-overfladen. (0, 0) er det øverste venstre hjørne. |
y | int | Y-koordinat (højde) i pixels i forhold til placeringen af HTML-overfladen. (0, 0) er det øverste venstre hjørne. |
Fortæller en HTML-overflade, hvor musen er.
MouseUp
void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
eMouseButton | EHTMLMouseButton | Museknappen, som blev sluppet. |
Fortæller en HTML-overflade, at en museknap er blevet sluppet.
Klikket vil opstå, hvor overfladen tror, at musen er, baseret på det seneste kald til
MouseMove.
MouseWheel
void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som interaktionen skal sendes til. |
nDelta | int32 | Antallet af pixels, der skal scrolles. |
Fortæller en HTML-overflade, at musehjulet er blevet flyttet.
PasteFromClipboard
void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som der skal kopieres til. |
Kopierer fra den lokale udklipsholder til den aktuelle side i en HTML-overflade.
Reload
void Reload( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som skal genindlæses. |
Opdaterer den aktuelle side.
Genindlæsningen vil sandsynligvis ramme den lokale cache i stedet for at gå over netværket. Dette svarer til F5 eller Ctrl+R i din valgte browser.
RemoveBrowser
void RemoveBrowser( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Browser-handlet, som skal frigives. |
Du SKAL kalde dette, når du er færdig med en HTML-overflade, og frigøre de resurser, der er forbundet med den.
Hvis du undlader at kalde dette, vil det medføre hukommelsesfejl!
SetBackgroundMode
void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet på overfladen slår baggrundstilstand til. |
bBackgroundMode | bool | Slå baggrundstilstand til eller fra. |
Aktiver/deaktiver lavresursebaggrundstilstand, hvor JavaScript og repaint-timere bliver spredt, resurser bliver mere aggressivt fjernet fra hukommelsen, og lyd-/videoelementer bliver sat på pause.
Når baggrundstilstand er aktiveret, udfører alle HTML5-video- og lydobjekter ".pause()" og får egenskaben "._steam_background_paused = 1".
Når baggrundstilstanden er deaktiveret, genoptages alle video- eller lydobjekter med den pågældende egenskab med ".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 );
Navn | Type | Beskrivelse |
pchHostname | const char * | Værtsnavnet på serveren, som cookien skal indstilles for. ("Host"-attribut) |
pchKey | const char * | Cookienavnet, som skal indstilles. |
pchValue | const char * | Cookieværdien, som skal indstilles. |
pchPath | const char * | Angiver "Path"-attributten på cookien. Du kan bruge dette til at begrænse cookies til en specifik sti på domænet. f.eks. "/accounts" |
nExpires | RTime32 | Indstiller "Expires"-attributten på cookien til det angivne tidsstempel i Unix Epoch-format (sekunder siden d. 1. januar 1970). |
bSecure | bool | Indstiller "Secure"-attributten. |
bHTTPOnly | bool | Indstiller "HttpOnly"-attributten. |
Indstiller en webcookie for et specifikt værtsnavn.
Du kan læse mere omkring de specifikke indstillinger for cookies her på
wikipedia.
SetHorizontalScroll
void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som den vandrette scroll-position indstilles for. |
nAbsolutePixelScroll | uint32 | Den absolutte pixelposition, som der skal scrolles til. 0 er den venstre side, og HTML_HorizontalScroll_t.unScrollMax er den højre side. |
Scroll vandret på den aktuelle side.
Returværdier: void
Udløser et
HTML_HorizontalScroll_t-tilbagekald.
Se også: HTML_HorizontalScroll_t,
SetVerticalScroll,
HTML_VerticalScroll_tSetKeyFocus
void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som nøglefokus skal indstilles på. |
bHasKeyFocus | bool | Slå nøglefokus til eller fra? |
Fortæller en HTML-overflade, hvis den i øjeblikket har nøglefokus, og styrer blandt andre ting visning af I-beam-markøren i tekststyring.
SetPageScaleFactor
void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som skal skaleres. |
flZoom | float | Angiver, hvor meget der skal zoomes. Dette kan variere fra 1 (100% som standard) til 2 (200%). |
nPointX | int | X-punktet i pixels, som der skal forstørres rundt om. Brug 0, hvis det er uden betydning. |
nPointY | int | Y-punktet i pixels, som der skal forstørres rundt om. Brug 0, hvis det er uden betydning. |
Zoom på den aktuelle side i en HTML-overflade.
Den aktuelle skaleringsfaktor er tilgængelig fra
HTML_NeedsPaint_t.flPageScale
,
HTML_HorizontalScroll_t.flPageScale
og
HTML_VerticalScroll_t.flPageScale
.
SetSize
void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som størrelse skal indstilles på. |
unWidth | uint32 | Overfladens bredde i pixels. |
unHeight | uint32 | Overfladens højde i pixels. |
Indstiller displayets overfladestørrelse i pixels.
SetVerticalScroll
void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som skal indstille den lodrette scroll-position. |
nAbsolutePixelScroll | uint32 | Den absolutte pixelposition, som der skal scrolles til. 0 er toppen, og HTML_HorizontalScroll_t.unScrollMax er bunden. |
Scroll lodret på den aktuelle side.
Returværdier: void
Udløser et
HTML_VerticalScroll_t-tilbagekald.
Se også: HTML_VerticalScroll_t,
SetHorizontalScroll,
HTML_HorizontalScroll_tShutdown
bool Shutdown();
Lukker ISteamHTMLSurface-grænsefladen ned og frigiver hukommelse og handles.
Du SKAL kalde dette, når du er færdig med at bruge denne grænseflade for at forhindre hukommelse- og handlefejl. Efter du har kaldt dette, vil alle funktionerne givet i denne grænseflade mislykkes, indtil du kalder
Init for at initialisere igen.
Returværdier: bool
Denne funktion returnerer i øjeblikket altid
true.
StopFind
void StopFind( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, hvor søgeresultater skal stoppes. |
Annuller en igangværende søgning.
Se også: FindStopLoad
void StopLoad( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som skal stoppe med at indlæse. |
Stop læsningen af den aktuelle HTML-side.
ViewSource
void ViewSource( HHTMLBrowser unBrowserHandle );
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen for at se dens aktuelle sides kilde. |
Åbn de aktuelle siders HTML-kildekode i en lokal standardteksteditor, som bruges til fejlfinding.
Tilbagekald
Disse er tilbagekald, som kan aktiveres ved at kalde
SteamAPI_RunCallbacks. Mange af disse vil blive udløst direkte som svar på medlemsfunktioner tilhørende
ISteamHTMLSurface
.
HTML_BrowserReady_t
En ny browser blev oprettet og er klar til brug.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Dette er handlet til browseren, som netop er blevet oprettet, som du kan bruge med fremtidige kald til ISteamHTMLSurface. |
Tilknyttede funktioner: CreateBrowserHTML_CanGoBackAndForward_t
Kaldes, når sidens historikstatus har ændret muligheden for at gå frem og tilbage.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
bCanGoBack | bool | Returnerer et svar på, om du kan navigere tilbage. |
bCanGoForward | bool | Returnerer et svar på, om du kan navigere fremad. |
HTML_ChangedTitle_t
Kaldes, når den aktuelle side i en browser får en ny titel.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchTitle | const char * | Sidens nye titel. |
HTML_CloseBrowser_t
Kaldes, når browseren er blevet anmodet om at lukke på grund af en brugerinteraktion. Dette skyldes typisk et JavaScript-kald fra
window.close()
.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
HTML_FileOpenDialog_t
Kaldes, når en browseroverflade har modtaget en åben fildialogboks fra et
<input type="file">
klik eller lignende. Du skal kalde
FileLoadDialogResponse sammen med filen/filerne, som brugeren har valgt.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som navigerer. |
pchTitle | const char * | Dialogboksens navn. (for eksempel "Upload billeder") |
pchInitialFile | const char * | Filnavnet, som siden vil have, du indstiller som standard. Den forventer muligvis en fil med dette navn eller filen, som brugeren uploadede tidligere. |
HTML_FinishedRequest_t
Kaldes, når en browser er færdig med at indlæse en side.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette kald var til. |
pchURL | const char * | URL'en, som blev indlæst. |
pchPageTitle | const char * | Titlen på siden, som blev indlæst. |
HTML_HideToolTip_t
Kaldes, når en browser vil skjule et værktøjstip.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
HTML_HorizontalScroll_t
Giver detaljer omkring synlighed og størrelsen af den vandrette scroll-bjælke.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
unScrollMax | uint32 | Den maksimale mængde, du kan scrolle vandret. |
unScrollCurrent | uint32 | Den aktuelle vandrette scroll-position. |
flPageScale | float | Den aktuelle sideskala. |
bVisible | bool | Angiver, om den vandrette scroll-bjælke er synlig. |
unPageSize | uint32 | Den samlede bredde af siden i pixels. |
Tilknyttede funktioner: SetHorizontalScrollHTML_JSAlert_t
Kaldes, når browseren ønsker at vise en JavaScript-advarselsdialogboks. Kald
JSDialogResponse, når brugeren afviser denne dialogboks, eller med det samme for at ignore dette.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette kald var til. |
pchMessage | const char * | Beskeden tilknyttet med dialogen. |
HTML_JSConfirm_t
Kaldes, når browseren ønsker at vise en JavaScript-bekræftelsesdialogboks. Kald
JSDialogResponse, når brugeren afviser denne dialogboks, eller med det samme for at ignorere dette.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette kald var til. |
pchMessage | const char * | Beskeden tilknyttet med dialogen. |
HTML_LinkAtPosition_t
Resultatet på et kald til
GetLinkAtPosition Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette kald var til. |
x | uint32 | Ubrugt. |
y | uint32 | Ubrugt. |
pchURL | const char * | URL'en, som findes ved denne position. NULL, hvis der ikke blev fundet et link. |
bInput | bool | Var positionen et inputfelt? |
bLiveLink | bool | |
Tilknyttede funktioner: GetLinkAtPositionHTML_NeedsPaint_t
Kaldes, når en browseroverflade har en afventende farve. Det er her, du får de reelle billeddata, som skal gengives på skærmen.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pBGRA | const char * | En pointer til B8G8R8A8-billeddataene for denne overflade. Gyldig, indtil SteamAPI_RunCallbacks bliver kaldt. |
unWide | uint32 | Den samlede bredde af pBGRA -teksturen. |
unTall | uint32 | Den samlede højde af pBGRA -teksturen. |
unUpdateX | uint32 | Forskydningen i X for skadens rect for denne opdatering. |
unUpdateY | uint32 | Forskydningen i Y for skadens rect for denne opdatering. |
unUpdateWide | uint32 | Bredden af skadens rect for denne opdatering. |
unUpdateTall | uint32 | Højden af skadens rect for denne opdatering. |
unScrollX | uint32 | Den vandrette scroll-position, som browseren var på, da denne tekstur blev gengivet. |
unScrollY | uint32 | Den lodrette scroll-position, som browseren var på, da denne tekstur blev gengivet. |
flPageScale | float | Skalafaktoren, som browseren var på, da denne tekstur blev gengivet. |
unPageSerial | uint32 | Forøges på hver nye sideindlæsning. Kan bruges til at forhindre gengivelse, når du navigerer til nye sider. |
HTML_NewWindow_t
En browser har oprettet et nyt HTML-vindue.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchURL | const char * | URL-adressen til at indlæse det nye vindue. |
unX | uint32 | X-positionen på siden, som skal vise pop op-vinduet. |
unY | uint32 | Y-positionen på siden, som skal vise pop op-vinduet. |
unWide | uint32 | Den samlede bredde af pBGRA-teksturen. |
unTall | uint32 | Den samlede højde af pBGRA-teksturen. |
unNewWindow_BrowserHandle | HHTMLBrowser | Handlet tilhørende den nye vinduesoverflade. |
HTML_OpenLinkInNewTab_t
Browseren har anmodet om at indlæse en URL i et nyt faneblad.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchURL | const char * | URL'en, som browseren ønsker at indlæse. |
HTML_SearchResults_t
Resultater fra en søgning.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
unResults | uint32 | Antallet af matchende resultater. |
unCurrentMatch | uint32 | Ordinalen tilhørende det aktuelle resultat i forhold til unResults . |
Tilknyttede funktioner: FindHTML_SetCursor_t
Kaldes, når en browser ønsker at ændre musemarkøren.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
eMouseCursor | uint32 | EMouseCursor skal vises. |
HTML_ShowToolTip_t
Kaldes, når en browser vil skjule et værktøjstip.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchMsg | const char * | Teksten til værktøjstippet, som skal vises. |
HTML_StartRequest_t
Kaldes, når en browser ønsker at navigere til en ny side.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som navigerer. |
pchURL | const char * | URL'en, som den ønsker at navigere til. |
pchTarget | const char * | HTML-linkets måltype (f.eks. _blank, _self, _parent, _top ). |
pchPostData | const char * | Alle indsendte data for anmodningen. |
bIsRedirect | bool | True, hvis det var en http-/html-omdirigering fra den sidste indlæsningsanmodning. |
Tilknyttede funktioner: LoadURLHTML_StatusText_t
Kaldes, når en browser vil have dig til at vise en oplysende besked. Dette bruges oftes, når du holder musen over links.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchMsg | const char * | Teksten tilhørende statusbeskeden, som skal vises. |
HTML_UpdateToolTip_t
Kaldes, når teksten i et eksisterende værktøjstip er blevet opdateret.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchMsg | const char * | Den nye tekst til værktøjstippet. |
HTML_URLChanged_t
Kaldes, når browseren navigerer til en ny URL-adresse
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
pchURL | const char * | URL'en, som browseren navigerer til. |
pchPostData | const char * | Alle indsendte data for anmodningen, NULL, hvis der ikke var nogen. |
bIsRedirect | bool | true, hvis dette var en http/html-omdirigering fra den sidste indlæsningsanmodning, ellers false. |
pchPageTitle | const char * | Sidens titel. |
bNewNavigation | bool | Dette er true, hvis siden er ændret i stedet for bare at kalde til browserens historik-API. |
HTML_VerticalScroll_t
Giver detaljer omkring synlighed og størrelsen af den lodrette scroll-bjælke.
Navn | Type | Beskrivelse |
unBrowserHandle | HHTMLBrowser | Handlet tilhørende overfladen, som dette tilbagekald er til. |
unScrollMax | uint32 | Den maksimale mængde, du kan scrolle lodret. |
unScrollCurrent | uint32 | Den aktuelle lodrette scroll-position. |
flPageScale | float | Den aktuelle sideskala. |
bVisible | bool | Angiver, om den lodrette scroll-bjælke er synlig. |
unPageSize | uint32 | Den samlede højde af siden i pixels. |
Tilknyttede funktioner: SetVerticalScrollEnums
Disse er optællinger, som defineres til brug med ISteamHTMLSurface.
EHTMLKeyModifiers
Bruges til at give browseren besked om, hvilke taster der trykkes med:
KeyChar,
KeyUp og
KeyDown. Disse flag kan tilføjes sammen ved at bruge bitwise OR.
Navn | Værdi | Beskrivelse |
k_eHTMLKeyModifier_None | 0 | Der er ikke trykket på nogen modifikationer. |
k_eHTMLKeyModifier_AltDown | 1 << 0 | Der trykkes på en af Alt-tasterne. |
k_eHTMLKeyModifier_CtrlDown | 1 << 1 | Der trykkes på en af Ctrl-tasterne. |
k_eHTMLKeyModifier_ShiftDown | 1 << 2 | Der trykkes på en af Shift-tasterne. |
EHTMLMouseButton
Bruges til at give browseren besked, når der trykkes med en museknap:
MouseUp,
MouseDown og
MouseDoubleClick.
Navn | Værdi | Beskrivelse |
eHTMLMouseButton_Left | 0 | Der trykkes på den venstre knap. |
eHTMLMouseButton_Right | 1 | Der trykkes på den højre knap. |
eHTMLMouseButton_Middle | 2 | Der trykkes på midterknappen. |
EMouseCursor
Dette viser musemarkører, som HTML-overfladen beder dig om at gengive.
Navn | Værdi | Beskrivelse |
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 | Vis ikke nogen brugerdefineret markør, brug i stedet din standard. |
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 | Bruges kun til at gentage på alle markører. Brugerdefinerede markører starter ved denne værdi og op. |
Typedefs
Disse er typedefinitioner, som defineres til brug med ISteamHTMLSurface.
Navn | Basistype | Beskrivelse |
HHTMLBrowser | uint32 | Repræsenterer et unikt handle til en HTML-overflade. |
Konstanter
Disse er konstanter, som defineres til brug med ISteamHTMLSurface.
Navn | Type | Værdi | Beskrivelse |
INVALID_HTMLBROWSER | uint32 | 0 | Indikerer, at et browser-handle er ugyldigt. Du bør initialisere dit eget HHTMLBrowser-handle til denne værdi og derefter indstille det tilbage til dette, når siden lukker. |
STEAMHTMLSURFACE_INTERFACE_VERSION | const char * | "STEAMHTMLSURFACE_INTERFACE_VERSION_003" | |