Documentação do Steamworks
Interface ISteamHTMLSurface
Interface para renderização e interação com páginas HTML.

Use esta interface para renderizar e exibir páginas HTML diretamente no jogo ou aplicativo. Chame Init antes de usar a interface e Shutdown quando terminar de usá-la.

Ela é baseada no Chromium Embedded Framework e é compatível com HTML5.

Consulte Superfície HTML do Steam para mais informações.

Funções de membro

Funções de membro de ISteamHTMLSurface são chamadas por meio da função de acesso global SteamHTMLSurface().

AddHeader

void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual adicionar o cabeçalho.
pchKeyconst char *O nome do cabeçalho a adicionar.
pchValueconst char *O valor do cabeçalho a associar com a chave.

Adiciona um cabeçalho a quaisquer requisições HTTP deste navegador.

Uma lista completa de campos de cabeçalho HTTP está disponível na Wikipédia (em inglês).

AllowStartRequest

void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície que está navegando.
bAllowedboolPermitir ou negar a navegação à requisição atual.

Define se um carregamento pendente é permitido ou deve ser cancelado.
AVISO: você DEVE chamar esta função em resposta a um retorno de chamada HTML_StartRequest_t.

É possível usar este recurso para limitar as páginas válidas permitidas na sua superfície HTML.

CopyToClipboard

void CopyToClipboard( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cujo texto selecionado copiar.

Copia o texto atualmente selecionado em uma superfície HTML para a área de transferência local.

CreateBrowser

SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );
NomeTipoDescrição
pchUserAgentconst char *Anexa esta string à string de agente de usuário geral do navegador, permitindo a detecção do seu cliente em servidores web. Use NULL se não precisar deste recurso.
pchUserCSSconst char *Permite definir um CSS a todas as páginas exibidas pelo navegador. Use NULL se não precisar desse recurso.

Cria um objeto navegador para exibição de uma página HTML.
AVISO: é necessário implementar handlers para os retornos de chamada HTML_BrowserReady_t, HTML_StartRequest_t, HTML_JSAlert_t, HTML_JSConfirm_t e HTML_FileOpenDialog_t!
Caso contrário, o navegador pode aparentar travar em vez de acessar novas páginas ou exibir pop-ups JavaScript!

AVISO: você DEVE chamar a função RemoveBrowser quando terminar de usar o navegador para liberar os recursos associados. Não fazê-lo resultará em um vazamento de memória.

Chame as funções SetSize e LoadURL para começar a usar a superfície de exibição.

Retorna: SteamAPICall_t, a ser usado com o resultado de chamada HTML_BrowserReady_t.

ExecuteJavascript

void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície que está navegando.
pchScriptconst char *O script JavaScript a executar.

Executa um script JavaScript na página carregada.

FileLoadDialogResponse

void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície que deseja exibir uma janela de abertura de arquivos.
pchSelectedFilesconst char **Deve ser um vetor de caminhos absolutos para os arquivos selecionados pelo usuário. NULL se o usuário não selecionou nenhum arquivo.

Permite reagir a uma página que deseja abrir uma janela de carregamento de arquivos.
AVISO: você DEVE chamar esta função em resposta a um retorno de chamada HTML_FileOpenDialog_t.

Find

void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual localizar a string.
pchSearchStrconst char *A string a localizar.
bCurrentlyInFindboolDefina como true em chamadas subsequentes para circular para a próxima string localizada.
bReverseboolLocalizar de baixo para cima?

Localiza uma string na página atual de uma superfície HTML.

O equivalente a pressionar "Ctrl+F" em um navegador comum. Realçará todas as strings localizadas.

Chame a função StopFind quando a string de entrada for alterada ou desejar interromper a busca.

Retorna: void
Dispara um retorno de chamada HTML_SearchResults_t.

GetLinkAtPosition

void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cujo link recuperar.
xintA coordenada X (largura), em pixels, na superfície. O valor 0 indica a borda esquerda.
yintA coordenada Y (altura), em pixels, na superfície. O valor 0 indica a borda superior.

Recupera detalhes de um link em uma posição específica da página atual em uma superfície HTML.

Retorna: void
Dispara um retorno de chamada HTML_LinkAtPosition_t.

GoBack

void GoBack( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual voltar no histórico.

Navega à página anterior do histórico.

GoForward

void GoForward( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual avançar no histórico.

Navega à próxima página do histórico.

Init

bool Init();
Inicializa a API de superfície HTML.

Deve ser chamada antes de usar quaisquer outras funções da interface.

Você DEVE chamar a função Shutdown quando terminar de usar a interface para liberar os recursos associados. Não fazê-lo resultará em um vazamento de memória!

Retorna: bool
true se a API foi inicializada com sucesso; false caso contrário.

JSDialogResponse

void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cuja janela JavaScript exibir.
bResultbooltrue para simular o pressionamento do botão "OK"; false para "Cancelar".

Permite reagir a uma página que deseja abrir uma janela JavaScript modal de notificação.
AVISO: você DEVE chamar esta função em resposta às respostas de chamada HTML_JSAlert_t e HTML_JSConfirm_t.

KeyChar

void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
cUnicodeCharuint32O ponto do caractere Unicode para este pressionamento de tecla. Um pressionamento pode gerar mais de um caractere.
eHTMLKeyModifiersEHTMLKeyModifiersDeve ser uma máscara de bits das teclas modificadoras pressionadas pelo usuário.

cUnicodeChar é o ponto de caractere Unidade para este pressionamento de tecla (e potencialmente vários caracteres por pressionamento).

KeyDown

void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
nNativeKeyCodeuint32O valor do código de tecla (keycode) virtual do SO.
eHTMLKeyModifiersEHTMLKeyModifiersDeve ser uma máscara de bits das teclas modificadoras pressionadas pelo usuário.

Interações com o teclado. nNativeKeyCode é o valor do código de tecla virtual do SO em uso.

KeyUp

void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
nNativeKeyCodeuint32O valor do código de tecla (keycode) virtual do SO.
eHTMLKeyModifiersEHTMLKeyModifiersDeve ser uma máscara de bits das teclas modificadoras pressionadas pelo usuário.

LoadURL

void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual carregar o URL.
pchURLconst char *O URL a carregar.
pchPostDataconst char *Opcionalmente enviar uma requisição POST com os dados aqui contidos. Um valor NULL não enviará dados.

Navega ao URL especificado.

Se for enviar dados por POST por meio do argumento pchPostData, então estes devem estar formatados como: nome1=valor1&nome2=valor2.

É possível carregar qualquer esquema de URI compatível com o Chromium Embedded Framework, incluindo, mas não limitado a: http://, https://, ftp:// e file:///. Não havendo esquema especificado, http:// será usado.

Retorna: void
Dispara um retorno de chamada HTML_StartRequest_t.

MouseDoubleClick

void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
eMouseButtonEHTMLMouseButtonO botão do mouse que foi pressionado duas vezes.

Comunica a uma superfície HTML que um botão do mouse foi pressionado duas vezes.

O clique ocorrerá onde a superfície acredita que o cursor do mouse está, de acordo com a última chamada a MouseMove.

MouseDown

void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
eMouseButtonEHTMLMouseButtonO botão do mouse que foi pressionado.

Comunica a uma superfície HTML que um botão do mouse foi pressionado.

O clique ocorrerá onde a superfície acredita que o cursor do mouse está, de acordo com a última chamada a MouseMove.

MouseMove

void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
xintA coordenada X (largura), em pixels, relativa à posição da superfície HTML. O valor 0 indica a borda esquerda.
yintA coordenada Y (altura), em pixels, relativa à posição da superfície HTML. O valor 0 indica a borda superior.

Comunica a uma superfície HTML a localização do cursor do mouse.

MouseUp

void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
eMouseButtonEHTMLMouseButtonO botão do mouse que foi solto.

Comunica a uma superfície HTML que um botão do mouse foi solto.

O clique ocorrerá onde a superfície acredita que o cursor do mouse está, de acordo com a última chamada a MouseMove.

MouseWheel

void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície à qual enviar a interação.
nDeltaint32A quantidade de pixels a rolar.

Comunica a uma superfície HTML que a roda do mouse foi movida.

PasteFromClipboard

void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual colar.

Cola o conteúdo da área de transferência local à página atual em uma superfície HTML.

Reload

void Reload( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície a atualizar.

Atualiza a página atual.

É provável que a atualização use o cache local em vez de usar a rede. Equivalente a pressionar F5 ou Ctrl+R em um navegador.

RemoveBrowser

void RemoveBrowser( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle do navegador a ser liberado.

Você DEVE chamar esta função quando terminar de usar uma superfície HTML, liberando os recursos associados.

Não fazê-lo resultará em um vazamento de memória!

SetBackgroundMode

void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície na qual alterar o modo de segundo plano.
bBackgroundModeboolAtivar ou desativar o modo de segundo plano.

Ativa/Desativa o modo de segundo plano, onde timers JavaScript e de renderização são regulados, recursos são removidos da memória com maior agressividade e elementos de áudio e vídeo são pausados.

Quando o modo de segundo plano é ativado, todos os objetos de vídeo e áudio HTML5 executarão a função ".pause()" e receberão a propriedade "._steam_background_paused = 1".
Quando o modo de segundo plano é desativado, todos os objetos de vídeo e áudio com essa propriedade voltarão a ser reproduzidos por meio da função ".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 );
NomeTipoDescrição
pchHostnameconst char *O nome de host do servidor para o qual definir o cookie. (Atributo "Host")
pchKeyconst char *O nome do cookie a definir.
pchValueconst char *O valor do cookie a definir.
pchPathconst char *Define o atributo "Path" (caminho) no cookie. Use para restringir o cookie a um caminho específico no domínio, como "/accounts".
nExpiresRTime32Define o atributo "Expires" (validade) no cookie para o horário especificado, no formato de Era Unix (segundos a partir de 1º de janeiro de 1970).
bSecureboolDefine o atributo "Secure" (seguro).
bHTTPOnlyboolDefine o atributo "HttpOnly".

Define um cookie da web para um nome de host específico.

Detalhes específicos sobre a definição de cookies estão disponíveis na Wikipédia.

SetHorizontalScroll

void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cuja posição horizontal de rolagem será definida.
nAbsolutePixelScrolluint32A posição absoluta, em pixels, à qual rolar. 0 é a borda esquerda e HTML_HorizontalScroll_t.unScrollMax é a borda direita.

Rola a página atual horizontalmente.

Retorna: void
Dispara um retorno de chamada HTML_HorizontalScroll_t.


Consulte também: HTML_HorizontalScroll_t, SetVerticalScroll, HTML_VerticalScroll_t

SetKeyFocus

void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície a definir o foco do teclado.
bHasKeyFocusboolAtivar o foco do teclado ou não?

Comunica a uma superfície HTML que ela possui o foco do teclado, com a exibição do cursor I piscante em áreas de inserção de texto, entre outras coisas.

SetPageScaleFactor

void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície a ser ampliada.
flZoomfloatA quantidade de ampliação. Pode variar entre 1 (100% — valor padrão) e 2 (200%).
nPointXintA coordenada X, em pixels, do ponto central de ampliação. Use 0 se não se importar.
nPointYintA coordenada Y, em pixels, do ponto central de ampliação. Use 0 se não se importar.

Amplia a página atual em uma superfície HTML.

O fator de ampliação está disponível nos atributos HTML_NeedsPaint_t.flPageScale, HTML_HorizontalScroll_t.flPageScale e HTML_VerticalScroll_t.flPageScale.

SetSize

void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cujo tamanho será definido.
unWidthuint32A largura da superfície, em pixels.
unHeightuint32A altura da superfície, em pixels.

Define o tamanho de exibição de uma superfície, em pixels.

SetVerticalScroll

void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cuja posição vertical de rolagem será definida.
nAbsolutePixelScrolluint32A posição absoluta, em pixels, à qual rolar. 0 é a borda superior e HTML_VerticalScroll_t.unScrollMax é a borda inferior.

Rola a página atual verticalmente.

Retorna: void
Dispara um retorno de chamada HTML_VerticalScroll_t.


Consulte também: HTML_VerticalScroll_t, SetHorizontalScroll, HTML_HorizontalScroll_t

Shutdown

bool Shutdown();
Encerra a interface ISteamHTMLSurface, liberando a memória e os handles.

Você DEVE chamar esta função quando terminar de usar a interface para evitar vazamentos de memória e handles. Depois desta chamada, todas as funções dessa interface falharão até chamar a função Init para reinicialização.

Retorna: bool
Esta função sempre retorna true.

StopFind

void StopFind( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cuja localização será interrompida.

Cancela uma localização de string em execução.

Consulte também: Find

StopLoad

void StopLoad( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cujo carregamento interromper.

Interrompe o carregamento da página HTML atual.

ViewSource

void ViewSource( HHTMLBrowser unBrowserHandle );
NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície cujo código-fonte visualizar.

Abre o código-fonte da página HTML atual no editor de texto padrão local, usado para depuração.

Retornos de chamada

Estes são os retornos de chamada (callbacks) que podem ser disparados ao chamar SteamAPI_RunCallbacks. Muitos podem ser disparados diretamente em resposta às funções de membro de ISteamHTMLSurface.

HTML_BrowserReady_t

Um novo navegador foi criado e está pronto para ser usado.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserEste é o handle do navegador recém-criado, que pode ser usado em chamadas futuras de funções da interface ISteamHTMLSurface.

Funções associadas: CreateBrowser

HTML_CanGoBackAndForward_t

Disparado quando o histórico de páginas foi alterado de forma a permitir ou impedir que se volte ou avance no mesmo.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
bCanGoBackboolRetorna se é possível voltar no histórico.
bCanGoForwardboolRetorna se é possível avançar no histórico.

HTML_ChangedTitle_t

Chamada quando a página atual de um navegador recebe um novo título.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchTitleconst char *O novo título da página.

HTML_CloseBrowser_t

Disparado quando uma requisição de fechamento do navegador foi recebida devido à interação do usuário; comumente devido a uma chamada JavaScript window.close().

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.

HTML_FileOpenDialog_t

Disparado quando uma superfície de navegador recebe uma janela de abertura de arquivos de um clique em um elemento <input type="file"> ou similar; você deverá chamar a função FileLoadDialogResponse com os arquivos selecionados pelo usuário.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície que está navegando.
pchTitleconst char *O nome da janela. (ex.: "Enviar imagens")
pchInitialFileconst char *O nome do arquivo que a página deseja definir como padrão. A página pode estar esperando um arquivo com esse nome ou o arquivo anteriormente enviado pelo usuário foi esse.

HTML_FinishedRequest_t

Disparado quando um navegador termina de carregar uma página.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchURLconst char *O URL da página carregada.
pchPageTitleconst char *O título da página carregada.

HTML_HideToolTip_t

Disparado quando um navegador deseja ocultar uma dica (tooltip).

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.

HTML_HorizontalScroll_t

Fornece detalhes da visibilidade e tamanho da barra de rolagem horizontal.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
unScrollMaxuint32O valor máximo de rolagem horizontal.
unScrollCurrentuint32A posição de rolagem horizontal atual.
flPageScalefloatO fator de escala atual da página.
bVisibleboolA barra de rolagem horizontal está visível?
unPageSizeuint32A largura total da página, em pixels.

Funções associadas: SetHorizontalScroll

HTML_JSAlert_t

Disparado quando o navegador deseja exibir uma janela de alerta JavaScript; chame JSDialogResponse quando o usuário fechar a janela ou, imediatamente, para ignorá-la completamente.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchMessageconst char *A mensagem associada à janela.

HTML_JSConfirm_t

Disparado quando o navegador deseja exibir uma janela de alerta JavaScript; chame JSDialogResponse quando o usuário fechar a janela ou, imediatamente, para ignorá-la completamente.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchMessageconst char *A mensagem associada à janela.

HTML_LinkAtPosition_t

Resultado de uma chamada à função GetLinkAtPosition.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
xuint32Não usado.
yuint32Não usado.
pchURLconst char *O URL encontrado na posição. NULL se nenhum link foi encontrado.
bInputboolA posição era um campo de entrada?
bLiveLinkbool

Funções associadas: GetLinkAtPosition

HTML_NeedsPaint_t

Disparado quando uma superfície de navegador tem uma renderização pendente. É por este retorno de chamada que se recupera os dados visuais para renderizar na tela.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pBGRAconst char *Um ponteiro para os dados de imagem B8G8R8A8 desta superfície, válidos até a próxima chamada a SteamAPI_RunCallbacks.
unWideuint32A largura total da textura pBGRA.
unTalluint32A altura total da textura pBGRA.
unUpdateXuint32O deslocamento horizontal (X) para o retângulo de dano para esta atualização.
unUpdateYuint32O deslocamento vertical (Y) para o retângulo de dano para esta atualização.
unUpdateWideuint32A largura do retângulo de dano para esta atualização.
unUpdateTalluint32A altura do retângulo de dano para esta atualização.
unScrollXuint32A posição da rolagem horizontal do navegador no momento da renderização da textura.
unScrollYuint32A posição da rolagem vertical do navegador no momento da renderização da textura.
flPageScalefloatO fator de escala do navegador no momento da renderização da textura.
unPageSerialuint32Incrementado a cada carregamento de página; use para rejeitar renderizações ao navegar para páginas novas.

HTML_NewWindow_t

Um navegador foi criado em uma nova janela HTML.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchURLconst char *O URL a carregar na nova janela.
unXuint32A coordenada X da página na qual exibir o pop-up.
unYuint32A coordenada Y da página na qual exibir o pop-up.
unWideuint32A largura total da textura pBGRA.
unTalluint32A altura total da textura pBGRA.
unNewWindow_BrowserHandleHHTMLBrowserO handle da superfície da nova janela.

HTML_OpenLinkInNewTab_t

O navegador requisitou o carregamento de um URL em uma nova aba.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchURLconst char *O URL que o navegador deseja carregar.

HTML_SearchResults_t

Resultados de uma localização.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
unResultsuint32A quantidade de correspondências encontradas.
unCurrentMatchuint32A posição do resultado atual com relação a unResults.

Funções associadas: Find

HTML_SetCursor_t

Disparado quando um navegador deseja alterar o cursor do mouse.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
eMouseCursoruint32O EMouseCursor a exibir.

HTML_ShowToolTip_t

Disparado quando um navegador deseja exibir uma dica (tooltip).

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchMsgconst char *O texto da dica que deseja exibir.

HTML_StartRequest_t

Disparado quando um navegador deseja navegar a uma página nova.
AVISO: você DEVE chamar a função AllowStartRequest em resposta a este retorno de chamada!

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície que está navegando.
pchURLconst char *O URL à qual se deseja navegar.
pchTargetconst char *O tipo de alvo do link HTML (i.é., _blank, _self, _parent, _top ).
pchPostDataconst char *Quaisquer dados enviados por POST na requisição.
bIsRedirectbooltrue se for um redirecionamento HTTP/HTML da última requisição de carregamento; false caso contrário.

Funções associadas: LoadURL

HTML_StatusText_t

Disparado quando um navegador deseja que exiba uma mensagem informativa. Comumente usado ao passar o cursor do mouse sobre links.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchMsgconst char *O texto da mensagem de estado a exibir.

HTML_UpdateToolTip_t

Disparado quando o texto de uma dica (tooltip) existente é atualizado.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchMsgconst char *O novo texto da dica.

HTML_URLChanged_t

Chamada quando o navegador está navegando para um novo URL.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
pchURLconst char *O URL para o qual o navegador está navegando.
pchPostDataconst char *Quaisquer dados enviados por POST na requisição, NULL se não havia dados.
bIsRedirectbooltrue se for um redirecionamento HTTP/HTML da última requisição de carregamento; false caso contrário.
pchPageTitleconst char *O título da página.
bNewNavigationbooltrue se a página foi alterada e não foi uma chamada à API de histórico do navegador.

HTML_VerticalScroll_t

Fornece detalhes da visibilidade e do tamanho da barra de rolagem vertical.

NomeTipoDescrição
unBrowserHandleHHTMLBrowserO handle da superfície associada ao retorno de chamada.
unScrollMaxuint32O valor máximo de rolagem vertical.
unScrollCurrentuint32A posição de rolagem vertical atual.
flPageScalefloatO fator de escala atual da página.
bVisibleboolA barra de rolagem vertical está visível?
unPageSizeuint32A altura total da página, em pixels.

Funções associadas: SetVerticalScroll

Enumerações

Estas são as enumerações definidas para uso com ISteamHTMLSurface.

EHTMLKeyModifiers

Usada para que o navegador saiba quais teclas foram pressionadas nas funções KeyChar, KeyUp e KeyDown. Os valores podem ser adicionados por meio de um OU bit a bit.

NomeValorDescrição
k_eHTMLKeyModifier_None0Nenhum modificador foi pressionado.
k_eHTMLKeyModifier_AltDown1 << 0Uma das teclas Alt está pressionada.
k_eHTMLKeyModifier_CtrlDown1 << 1Uma das teclas Ctrl está pressionada.
k_eHTMLKeyModifier_ShiftDown1 << 2Uma das teclas Shift está pressionada.

EHTMLMouseButton

Usada para que o navegador saiba quando um botão do mouse está pressionado nas funções MouseUp, MouseDown e MouseDoubleClick.

NomeValorDescrição
eHTMLMouseButton_Left0O botão esquerdo está pressionado.
eHTMLMouseButton_Right1O botão direito está pressionado.
eHTMLMouseButton_Middle2O botão do meio está pressionado.

EMouseCursor

Lista os cursores do mouse que a superfície HTML pedirá que sejam renderizados.

NomeValorDescrição
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_blank21Não exibir nenhum cursor especial, use o padrão.
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_last41Usado apenas para iterar por todos os cursores. Cursores personalizados começam deste valor para cima.

Tipos definidos

Estes são os tipos definidos por typedefs para uso com ISteamHTMLSurface.

NomeTipo baseDescrição
HHTMLBrowseruint32Representa um handle único para uma superfície HTML.

Constantes

Estas são as constantes definidas para uso com ISteamHTMLSurface.

NomeTipoValorDescrição
INVALID_HTMLBROWSERuint320Indica que um handle de navegador é inválido. Inicialize os seus handles HHTMLBrowser com este valor e coloque-os neste valor novamente quando a página for fechada.
STEAMHTMLSURFACE_INTERFACE_VERSIONconst char *"STEAMHTMLSURFACE_INTERFACE_VERSION_003"