Steamworks-dokumentation
ISteamHTMLSurface-grænseflade
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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som der skal tilføjes en overskrift til.
pchKeyconst char *Overskriftens navn, som skal tilføjes.
pchValueconst 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som navigerer.
bAllowedboolTillad eller nægt navigation til den aktuelle startanmodning.

Indstiller, om en afventende indlæsning er tilladt, eller om den skal annulleres.
BEMÆRK:Du SKAL kalde dette som svar på et HTML_StartRequest_t-tilbagekald.

Du kan bruge denne funktion til at begrænse gyldige sider, som er tilladt i din HTML-overflade.

CopyToClipboard

void CopyToClipboard( HHTMLBrowser unBrowserHandle );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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 );
NavnTypeBeskrivelse
pchUserAgentconst 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.
pchUserCSSconst 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.
BEMÆRK: Du skal have implementeret tilbagekaldshandlers for HTML_BrowserReady_t, HTML_StartRequest_t, HTML_JSAlert_t, HTML_JSConfirm_t, and HTML_FileOpenDialog_t!
Hvis du ikke implementerer disse tilbagekaldshandlers, kan browseren lade til at hænge i stedet for at navigere til nye sider eller udløse javascript popups!

BEMÆRK: Du SKAL kalde RemoveBrowser, når du er færdig med at bruge denne browser til at frigøre resurserne tilknyttet den. Hvis du undlader at gøre det, vil det medføre hukommelsesfejl.

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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som navigerer.
pchScriptconst 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som ønsker at fremkalde en åben fildialogboks.
pchSelectedFilesconst 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.
BEMÆRK:Du SKAL kalde dette som svar på et HTML_FileOpenDialog_t-tilbagekald.

Find

void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, strengen skal findes i.
pchSearchStrconst char *Strengen, som der skal søges efter.
bCurrentlyInFindboolSæt denne til true på efterfølgende kald for at gå til den næste matchende streng.
bReverseboolSø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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som der hentes link fra.
xintX-position (bredde) i pixels indenfor overfladen. (0, 0) er det øverste venstre hjørne.
yintY-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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som der skal navigeres tilbage til.

Naviger tilbage i sidehistorikken.

GoForward

void GoForward( HHTMLBrowser unBrowserHandle );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som fremkalder en dialogboks.
bResultboolAngiv 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.
BEMÆRK:Du SKAL kalde dette som svar på HTML_JSAlert_t- og HTML_JSConfirm_t-tilbagekald.

KeyChar

void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
cUnicodeCharuint32Tegnpunktet i Unicode-format for dette tastetryk og potentielt flere tegn pr. tryk.
eHTMLKeyModifiersEHTMLKeyModifiersDette 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
nNativeKeyCodeuint32Dette er den virtuelle nøglekodeværdi fra operativsystemet.
eHTMLKeyModifiersEHTMLKeyModifiersDette 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
nNativeKeyCodeuint32Dette er den virtuelle nøglekodeværdi fra operativsystemet.
eHTMLKeyModifiersEHTMLKeyModifiersDette 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som denne URL skal indlæses i.
pchURLconst char *URL'en, som skal loades.
pchPostDataconst 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
eMouseButtonEHTMLMouseButtonMuseknappen, 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
eMouseButtonEHTMLMouseButtonMuseknappen, 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
xintX-koordinat (bredde) i pixels i forhold til placeringen af HTML-overfladen. (0, 0) er det øverste venstre hjørne.
yintY-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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
eMouseButtonEHTMLMouseButtonMuseknappen, 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som interaktionen skal sendes til.
nDeltaint32Antallet af pixels, der skal scrolles.

Fortæller en HTML-overflade, at musehjulet er blevet flyttet.

PasteFromClipboard

void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserBrowser-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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet på overfladen slår baggrundstilstand til.
bBackgroundModeboolSlå 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 );
NavnTypeBeskrivelse
pchHostnameconst char *Værtsnavnet på serveren, som cookien skal indstilles for. ("Host"-attribut)
pchKeyconst char *Cookienavnet, som skal indstilles.
pchValueconst char *Cookieværdien, som skal indstilles.
pchPathconst 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"
nExpiresRTime32Indstiller "Expires"-attributten på cookien til det angivne tidsstempel i Unix Epoch-format (sekunder siden d. 1. januar 1970).
bSecureboolIndstiller "Secure"-attributten.
bHTTPOnlyboolIndstiller "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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som den vandrette scroll-position indstilles for.
nAbsolutePixelScrolluint32Den 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_t

SetKeyFocus

void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som nøglefokus skal indstilles på.
bHasKeyFocusboolSlå 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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som skal skaleres.
flZoomfloatAngiver, hvor meget der skal zoomes. Dette kan variere fra 1 (100% som standard) til 2 (200%).
nPointXintX-punktet i pixels, som der skal forstørres rundt om. Brug 0, hvis det er uden betydning.
nPointYintY-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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som størrelse skal indstilles på.
unWidthuint32Overfladens bredde i pixels.
unHeightuint32Overfladens højde i pixels.

Indstiller displayets overfladestørrelse i pixels.

SetVerticalScroll

void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som skal indstille den lodrette scroll-position.
nAbsolutePixelScrolluint32Den 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_t

Shutdown

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 );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, hvor søgeresultater skal stoppes.

Annuller en igangværende søgning.

Se også: Find

StopLoad

void StopLoad( HHTMLBrowser unBrowserHandle );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som skal stoppe med at indlæse.

Stop læsningen af den aktuelle HTML-side.

ViewSource

void ViewSource( HHTMLBrowser unBrowserHandle );
NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserDette er handlet til browseren, som netop er blevet oprettet, som du kan bruge med fremtidige kald til ISteamHTMLSurface.

Tilknyttede funktioner: CreateBrowser

HTML_CanGoBackAndForward_t

Kaldes, når sidens historikstatus har ændret muligheden for at gå frem og tilbage.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
bCanGoBackboolReturnerer et svar på, om du kan navigere tilbage.
bCanGoForwardboolReturnerer 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchTitleconst 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().

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som navigerer.
pchTitleconst char *Dialogboksens navn. (for eksempel "Upload billeder")
pchInitialFileconst 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette kald var til.
pchURLconst char *URL'en, som blev indlæst.
pchPageTitleconst char *Titlen på siden, som blev indlæst.

HTML_HideToolTip_t

Kaldes, når en browser vil skjule et værktøjstip.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.

HTML_HorizontalScroll_t

Giver detaljer omkring synlighed og størrelsen af den vandrette scroll-bjælke.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
unScrollMaxuint32Den maksimale mængde, du kan scrolle vandret.
unScrollCurrentuint32Den aktuelle vandrette scroll-position.
flPageScalefloatDen aktuelle sideskala.
bVisibleboolAngiver, om den vandrette scroll-bjælke er synlig.
unPageSizeuint32Den samlede bredde af siden i pixels.

Tilknyttede funktioner: SetHorizontalScroll

HTML_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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette kald var til.
pchMessageconst 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette kald var til.
pchMessageconst char *Beskeden tilknyttet med dialogen.

HTML_LinkAtPosition_t

Resultatet på et kald til GetLinkAtPosition

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette kald var til.
xuint32Ubrugt.
yuint32Ubrugt.
pchURLconst char *URL'en, som findes ved denne position. NULL, hvis der ikke blev fundet et link.
bInputboolVar positionen et inputfelt?
bLiveLinkbool

Tilknyttede funktioner: GetLinkAtPosition

HTML_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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pBGRAconst char *En pointer til B8G8R8A8-billeddataene for denne overflade. Gyldig, indtil SteamAPI_RunCallbacks bliver kaldt.
unWideuint32Den samlede bredde af pBGRA-teksturen.
unTalluint32Den samlede højde af pBGRA-teksturen.
unUpdateXuint32Forskydningen i X for skadens rect for denne opdatering.
unUpdateYuint32Forskydningen i Y for skadens rect for denne opdatering.
unUpdateWideuint32Bredden af skadens rect for denne opdatering.
unUpdateTalluint32Højden af skadens rect for denne opdatering.
unScrollXuint32Den vandrette scroll-position, som browseren var på, da denne tekstur blev gengivet.
unScrollYuint32Den lodrette scroll-position, som browseren var på, da denne tekstur blev gengivet.
flPageScalefloatSkalafaktoren, som browseren var på, da denne tekstur blev gengivet.
unPageSerialuint32Forø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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchURLconst char *URL-adressen til at indlæse det nye vindue.
unXuint32X-positionen på siden, som skal vise pop op-vinduet.
unYuint32Y-positionen på siden, som skal vise pop op-vinduet.
unWideuint32Den samlede bredde af pBGRA-teksturen.
unTalluint32Den samlede højde af pBGRA-teksturen.
unNewWindow_BrowserHandleHHTMLBrowserHandlet tilhørende den nye vinduesoverflade.

HTML_OpenLinkInNewTab_t

Browseren har anmodet om at indlæse en URL i et nyt faneblad.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchURLconst char *URL'en, som browseren ønsker at indlæse.

HTML_SearchResults_t

Resultater fra en søgning.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
unResultsuint32Antallet af matchende resultater.
unCurrentMatchuint32Ordinalen tilhørende det aktuelle resultat i forhold til unResults.

Tilknyttede funktioner: Find

HTML_SetCursor_t

Kaldes, når en browser ønsker at ændre musemarkøren.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
eMouseCursoruint32EMouseCursor skal vises.

HTML_ShowToolTip_t

Kaldes, når en browser vil skjule et værktøjstip.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchMsgconst char *Teksten til værktøjstippet, som skal vises.

HTML_StartRequest_t

Kaldes, når en browser ønsker at navigere til en ny side.
BEMÆRK: Du SKAL kalde AllowStartRequest som svar på dette tilbagekald!

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som navigerer.
pchURLconst char *URL'en, som den ønsker at navigere til.
pchTargetconst char *HTML-linkets måltype (f.eks. _blank, _self, _parent, _top ).
pchPostDataconst char *Alle indsendte data for anmodningen.
bIsRedirectboolTrue, hvis det var en http-/html-omdirigering fra den sidste indlæsningsanmodning.

Tilknyttede funktioner: LoadURL

HTML_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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchMsgconst char *Teksten tilhørende statusbeskeden, som skal vises.

HTML_UpdateToolTip_t

Kaldes, når teksten i et eksisterende værktøjstip er blevet opdateret.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchMsgconst char *Den nye tekst til værktøjstippet.

HTML_URLChanged_t

Kaldes, når browseren navigerer til en ny URL-adresse

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
pchURLconst char *URL'en, som browseren navigerer til.
pchPostDataconst char *Alle indsendte data for anmodningen, NULL, hvis der ikke var nogen.
bIsRedirectbooltrue, hvis dette var en http/html-omdirigering fra den sidste indlæsningsanmodning, ellers false.
pchPageTitleconst char *Sidens titel.
bNewNavigationboolDette 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.

NavnTypeBeskrivelse
unBrowserHandleHHTMLBrowserHandlet tilhørende overfladen, som dette tilbagekald er til.
unScrollMaxuint32Den maksimale mængde, du kan scrolle lodret.
unScrollCurrentuint32Den aktuelle lodrette scroll-position.
flPageScalefloatDen aktuelle sideskala.
bVisibleboolAngiver, om den lodrette scroll-bjælke er synlig.
unPageSizeuint32Den samlede højde af siden i pixels.

Tilknyttede funktioner: SetVerticalScroll

Enums

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.

NavnVærdiBeskrivelse
k_eHTMLKeyModifier_None0Der er ikke trykket på nogen modifikationer.
k_eHTMLKeyModifier_AltDown1 << 0Der trykkes på en af Alt-tasterne.
k_eHTMLKeyModifier_CtrlDown1 << 1Der trykkes på en af Ctrl-tasterne.
k_eHTMLKeyModifier_ShiftDown1 << 2Der trykkes på en af Shift-tasterne.

EHTMLMouseButton

Bruges til at give browseren besked, når der trykkes med en museknap:MouseUp, MouseDown og MouseDoubleClick.

NavnVærdiBeskrivelse
eHTMLMouseButton_Left0Der trykkes på den venstre knap.
eHTMLMouseButton_Right1Der trykkes på den højre knap.
eHTMLMouseButton_Middle2Der trykkes på midterknappen.

EMouseCursor

Dette viser musemarkører, som HTML-overfladen beder dig om at gengive.

NavnVærdiBeskrivelse
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_blank21Vis ikke nogen brugerdefineret markør, brug i stedet din standard.
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_last41Bruges 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.

NavnBasistypeBeskrivelse
HHTMLBrowseruint32Repræsenterer et unikt handle til en HTML-overflade.

Konstanter

Disse er konstanter, som defineres til brug med ISteamHTMLSurface.

NavnTypeVærdiBeskrivelse
INVALID_HTMLBROWSERuint320Indikerer, 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_VERSIONconst char *"STEAMHTMLSURFACE_INTERFACE_VERSION_003"