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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual adicionar o cabeçalho. |
pchKey | const char * | O nome do cabeçalho a adicionar. |
pchValue | const 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície que está navegando. |
bAllowed | bool | Permitir ou negar a navegação à requisição atual. |
Define se um carregamento pendente é permitido ou deve ser cancelado.
É possível usar este recurso para limitar as páginas válidas permitidas na sua superfície HTML.
CopyToClipboard
void CopyToClipboard( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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 );
Nome | Tipo | Descrição |
pchUserAgent | const 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. |
pchUserCSS | const 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.
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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície que está navegando. |
pchScript | const char * | O script JavaScript a executar. |
Executa um script JavaScript na página carregada.
FileLoadDialogResponse
void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície que deseja exibir uma janela de abertura de arquivos. |
pchSelectedFiles | const 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.
Find
void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície na qual localizar a string. |
pchSearchStr | const char * | A string a localizar. |
bCurrentlyInFind | bool | Defina como true em chamadas subsequentes para circular para a próxima string localizada. |
bReverse | bool | Localizar 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cujo link recuperar. |
x | int | A coordenada X (largura), em pixels, na superfície. O valor 0 indica a borda esquerda. |
y | int | A 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície na qual voltar no histórico. |
Navega à página anterior do histórico.
GoForward
void GoForward( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cuja janela JavaScript exibir. |
bResult | bool | true 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.
KeyChar
void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
cUnicodeChar | uint32 | O ponto do caractere Unicode para este pressionamento de tecla. Um pressionamento pode gerar mais de um caractere. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Deve 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
nNativeKeyCode | uint32 | O valor do código de tecla (keycode) virtual do SO. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Deve 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
nNativeKeyCode | uint32 | O valor do código de tecla (keycode) virtual do SO. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Deve ser uma máscara de bits das teclas modificadoras pressionadas pelo usuário. |
LoadURL
void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície na qual carregar o URL. |
pchURL | const char * | O URL a carregar. |
pchPostData | const 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
eMouseButton | EHTMLMouseButton | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
eMouseButton | EHTMLMouseButton | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
x | int | A coordenada X (largura), em pixels, relativa à posição da superfície HTML. O valor 0 indica a borda esquerda. |
y | int | A 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
eMouseButton | EHTMLMouseButton | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície à qual enviar a interação. |
nDelta | int32 | A quantidade de pixels a rolar. |
Comunica a uma superfície HTML que a roda do mouse foi movida.
PasteFromClipboard
void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície na qual alterar o modo de segundo plano. |
bBackgroundMode | bool | Ativar 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 );
Nome | Tipo | Descrição |
pchHostname | const char * | O nome de host do servidor para o qual definir o cookie. (Atributo "Host") |
pchKey | const char * | O nome do cookie a definir. |
pchValue | const char * | O valor do cookie a definir. |
pchPath | const char * | Define o atributo "Path" (caminho) no cookie. Use para restringir o cookie a um caminho específico no domínio, como "/accounts". |
nExpires | RTime32 | Define 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). |
bSecure | bool | Define o atributo "Secure" (seguro). |
bHTTPOnly | bool | Define 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cuja posição horizontal de rolagem será definida. |
nAbsolutePixelScroll | uint32 | A 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_tSetKeyFocus
void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície a definir o foco do teclado. |
bHasKeyFocus | bool | Ativar 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície a ser ampliada. |
flZoom | float | A quantidade de ampliação. Pode variar entre 1 (100% — valor padrão) e 2 (200%). |
nPointX | int | A coordenada X, em pixels, do ponto central de ampliação. Use 0 se não se importar. |
nPointY | int | A 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cujo tamanho será definido. |
unWidth | uint32 | A largura da superfície, em pixels. |
unHeight | uint32 | A 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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cuja posição vertical de rolagem será definida. |
nAbsolutePixelScroll | uint32 | A 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_tShutdown
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 );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cuja localização será interrompida. |
Cancela uma localização de string em execução.
Consulte também: FindStopLoad
void StopLoad( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície cujo carregamento interromper. |
Interrompe o carregamento da página HTML atual.
ViewSource
void ViewSource( HHTMLBrowser unBrowserHandle );
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | Este é o handle do navegador recém-criado, que pode ser usado em chamadas futuras de funções da interface ISteamHTMLSurface. |
Funções associadas: CreateBrowserHTML_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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
bCanGoBack | bool | Retorna se é possível voltar no histórico. |
bCanGoForward | bool | Retorna 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchTitle | const 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()
.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície que está navegando. |
pchTitle | const char * | O nome da janela. (ex.: "Enviar imagens") |
pchInitialFile | const 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchURL | const char * | O URL da página carregada. |
pchPageTitle | const char * | O título da página carregada. |
HTML_HideToolTip_t
Disparado quando um navegador deseja ocultar uma dica (tooltip).
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
HTML_HorizontalScroll_t
Fornece detalhes da visibilidade e tamanho da barra de rolagem horizontal.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
unScrollMax | uint32 | O valor máximo de rolagem horizontal. |
unScrollCurrent | uint32 | A posição de rolagem horizontal atual. |
flPageScale | float | O fator de escala atual da página. |
bVisible | bool | A barra de rolagem horizontal está visível? |
unPageSize | uint32 | A largura total da página, em pixels. |
Funções associadas: SetHorizontalScrollHTML_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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchMessage | const 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchMessage | const char * | A mensagem associada à janela. |
HTML_LinkAtPosition_t
Resultado de uma chamada à função
GetLinkAtPosition.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
x | uint32 | Não usado. |
y | uint32 | Não usado. |
pchURL | const char * | O URL encontrado na posição. NULL se nenhum link foi encontrado. |
bInput | bool | A posição era um campo de entrada? |
bLiveLink | bool | |
Funções associadas: GetLinkAtPositionHTML_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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pBGRA | const char * | Um ponteiro para os dados de imagem B8G8R8A8 desta superfície, válidos até a próxima chamada a SteamAPI_RunCallbacks. |
unWide | uint32 | A largura total da textura pBGRA . |
unTall | uint32 | A altura total da textura pBGRA . |
unUpdateX | uint32 | O deslocamento horizontal (X) para o retângulo de dano para esta atualização. |
unUpdateY | uint32 | O deslocamento vertical (Y) para o retângulo de dano para esta atualização. |
unUpdateWide | uint32 | A largura do retângulo de dano para esta atualização. |
unUpdateTall | uint32 | A altura do retângulo de dano para esta atualização. |
unScrollX | uint32 | A posição da rolagem horizontal do navegador no momento da renderização da textura. |
unScrollY | uint32 | A posição da rolagem vertical do navegador no momento da renderização da textura. |
flPageScale | float | O fator de escala do navegador no momento da renderização da textura. |
unPageSerial | uint32 | Incrementado 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchURL | const char * | O URL a carregar na nova janela. |
unX | uint32 | A coordenada X da página na qual exibir o pop-up. |
unY | uint32 | A coordenada Y da página na qual exibir o pop-up. |
unWide | uint32 | A largura total da textura pBGRA. |
unTall | uint32 | A altura total da textura pBGRA. |
unNewWindow_BrowserHandle | HHTMLBrowser | O handle da superfície da nova janela. |
HTML_OpenLinkInNewTab_t
O navegador requisitou o carregamento de um URL em uma nova aba.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchURL | const char * | O URL que o navegador deseja carregar. |
HTML_SearchResults_t
Resultados de uma localização.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
unResults | uint32 | A quantidade de correspondências encontradas. |
unCurrentMatch | uint32 | A posição do resultado atual com relação a unResults . |
Funções associadas: FindHTML_SetCursor_t
Disparado quando um navegador deseja alterar o cursor do mouse.
HTML_ShowToolTip_t
Disparado quando um navegador deseja exibir uma dica (tooltip).
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchMsg | const 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!
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície que está navegando. |
pchURL | const char * | O URL à qual se deseja navegar. |
pchTarget | const char * | O tipo de alvo do link HTML (i.é., _blank, _self, _parent, _top ). |
pchPostData | const char * | Quaisquer dados enviados por POST na requisição. |
bIsRedirect | bool | true se for um redirecionamento HTTP/HTML da última requisição de carregamento; false caso contrário. |
Funções associadas: LoadURLHTML_StatusText_t
Disparado quando um navegador deseja que exiba uma mensagem informativa. Comumente usado ao passar o cursor do mouse sobre links.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchMsg | const char * | O texto da mensagem de estado a exibir. |
HTML_UpdateToolTip_t
Disparado quando o texto de uma dica (tooltip) existente é atualizado.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchMsg | const char * | O novo texto da dica. |
HTML_URLChanged_t
Chamada quando o navegador está navegando para um novo URL.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
pchURL | const char * | O URL para o qual o navegador está navegando. |
pchPostData | const char * | Quaisquer dados enviados por POST na requisição, NULL se não havia dados. |
bIsRedirect | bool | true se for um redirecionamento HTTP/HTML da última requisição de carregamento; false caso contrário. |
pchPageTitle | const char * | O título da página. |
bNewNavigation | bool | true 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.
Nome | Tipo | Descrição |
unBrowserHandle | HHTMLBrowser | O handle da superfície associada ao retorno de chamada. |
unScrollMax | uint32 | O valor máximo de rolagem vertical. |
unScrollCurrent | uint32 | A posição de rolagem vertical atual. |
flPageScale | float | O fator de escala atual da página. |
bVisible | bool | A barra de rolagem vertical está visível? |
unPageSize | uint32 | A altura total da página, em pixels. |
Funções associadas: SetVerticalScrollEnumeraçõ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.
Nome | Valor | Descrição |
k_eHTMLKeyModifier_None | 0 | Nenhum modificador foi pressionado. |
k_eHTMLKeyModifier_AltDown | 1 << 0 | Uma das teclas Alt está pressionada. |
k_eHTMLKeyModifier_CtrlDown | 1 << 1 | Uma das teclas Ctrl está pressionada. |
k_eHTMLKeyModifier_ShiftDown | 1 << 2 | Uma 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.
Nome | Valor | Descrição |
eHTMLMouseButton_Left | 0 | O botão esquerdo está pressionado. |
eHTMLMouseButton_Right | 1 | O botão direito está pressionado. |
eHTMLMouseButton_Middle | 2 | O botão do meio está pressionado. |
EMouseCursor
Lista os cursores do mouse que a superfície HTML pedirá que sejam renderizados.
Nome | Valor | Descrição |
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 | Não exibir nenhum cursor especial, use o padrão. |
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 | Usado 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.
Nome | Tipo base | Descrição |
HHTMLBrowser | uint32 | Representa um handle único para uma superfície HTML. |
Constantes
Estas são as constantes definidas para uso com ISteamHTMLSurface.
Nome | Tipo | Valor | Descrição |
INVALID_HTMLBROWSER | uint32 | 0 | Indica 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_VERSION | const char * | "STEAMHTMLSURFACE_INTERFACE_VERSION_003" | |