Interfaz para mostrar páginas HTML e interactuar con ellas.
Esta interfaz se puede usar para mostrar y visualizar páginas HTML directamente en el juego o la aplicación. Debes llamar a
Init antes de usar esta interfaz y a
Shutdown cuando hayas terminado de usarla.
Está desarrollada a partir de Chromium Embedded Framework y es compatible con HTML5.
Consulta
Superficies HTML de Steam para obtener más información.
Funciones miembro
Las funciones miembro para
ISteamHTMLSurface
se llaman a través de la función de acceso global
SteamHTMLSurface()
.
AddHeader
void AddHeader( HHTMLBrowser unBrowserHandle, const char *pchKey, const char *pchValue );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie a la que se le agrega la cabecera. |
pchKey | const char * | El nombre de la cabecera a agregar. |
pchValue | const char * | El valor de la cabecera a asociar con la clave. |
Añade una cabecera a cualquier solicitud HTTP procedente de este navegador.
Una lista completa de campos de solicitud estándar están disponibles aquí en
wikipedia.
AllowStartRequest
void AllowStartRequest( HHTMLBrowser unBrowserHandle, bool bAllowed );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie que se está navegando. |
bAllowed | bool | Permite o deniega la navegación a la solicitud de inicio actual. |
Establece si se permite una carga pendiente o debe ser cancelada.
Esta característica se puede usar para limitar las páginas que se permiten en una superficie HTML.
CopyToClipboard
void CopyToClipboard( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie desde la que se va a copiar el texto. |
Copia en el portapapeles local el texto seleccionado de la página actual en una superficie HTML.
CreateBrowser
SteamAPICall_t CreateBrowser( const char *pchUserAgent, const char *pchUserCSS );
Nombre | Tipo | Descripción |
pchUserAgent | const char * | Anexa la cadena a la cadena de agente de usuario general del navegador, lo que te permite detectar tu cliente en servidores web. Pon NULL si no necesitas esta funcionalidad. |
pchUserCSS | const char * | Esto permite asignar un estilo CSS a todas las páginas mostradas por este navegador. Pon NULL si no necesitas esta funcionalidad. |
Crea un objeto de navegador para mostrar una página HTML.
Querrás llamar a
SetSize y
LoadURL para comenzar a usar tu superficie de visualización.
Devuelve: SteamAPICall_t para ser usado con el resultado de la llamada a
HTML_BrowserReady_t.
ExecuteJavascript
void ExecuteJavascript( HHTMLBrowser unBrowserHandle, const char *pchScript );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie que se está navegando. |
pchScript | const char * | El script de JavaScript a ejecutar. |
Ejecuta un script de JavaScript en la página cargada.
FileLoadDialogResponse
void FileLoadDialogResponse( HHTMLBrowser unBrowserHandle, const char **pchSelectedFiles );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que quiere generar un diálogo de apertura de archivo. |
pchSelectedFiles | const char ** | Debe ser un vector de rutas absolutas a los archivos que ha seleccionado el usuario. NULL si el usuario no seleccionó ningún archivo. |
Te permite reaccionar a una página que quiere abrir un cuadro de diálogo de carga de archivos.
Find
void Find( HHTMLBrowser unBrowserHandle, const char *pchSearchStr, bool bCurrentlyInFind, bool bReverse );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie en la que se busca la cadena. |
pchSearchStr | const char * | La cadena que se quiere encontrar. |
bCurrentlyInFind | bool | Establece esto a true en las llamadas subsiguientes para pasar a la siguiente cadena coincidente. |
bReverse | bool | ¿Buscar desde abajo hacia arriba? |
Busca una cadena en la página actual de una superficie HTML.
Esto equivale a pulsar "Ctrl+F" en el navegador. Resaltará todas las cadenas que coincidan.
Debes llamar a
StopFind cuando la cadena de entrada haya cambiado o desees detener la búsqueda.
Devuelve: void
Activa la función callback
HTML_SearchResults_t.
GetLinkAtPosition
void GetLinkAtPosition( HHTMLBrowser unBrowserHandle, int x, int y );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie desde la que se obtiene un enlace. |
x | int | Posición X (ancho) en píxeles dentro de la superficie. (0, 0) es la esquina superior izquierda. |
y | int | Posición Y (alto) en píxeles dentro de la superficie. (0, 0) es la esquina superior izquierda. |
Recupera detalles de un vínculo en la posición especificada de la página actual en una superficie HTML.
Devuelve: void
Activa la función callback
HTML_LinkAtPosition_t.
GoBack
void GoBack( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a retroceder. |
Retrocede en el historial de páginas.
GoForward
void GoForward( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para navegar hacia adelante. |
Avanza en el historial de páginas.
Init
bool Init();
Inicializa la API de la superficie HTML.
Hay que llamar a esta función antes de usar cualquier otra función en esta interfaz.
Es necesario llamar a la función
Shutdown al terminar de usar la interfaz para liberar los recursos asociados. En caso contrario, ¡habrá una pérdida de memoria!
Devuelve: bool
true si la API se inicializó con éxito; de lo contrario,
false.
JSDialogResponse
void JSDialogResponse( HHTMLBrowser unBrowserHandle, bool bResult );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que va a generar un diálogo. |
bResult | bool | Establece esto en true para simular que se pulsa el botón «Aceptar», de lo contrario, false para "Cancelar". |
Te permite reaccionar a una página que intenta abrir un cuadro de diálogo modal de JavaScript.
KeyChar
void KeyChar( HHTMLBrowser unBrowserHandle, uint32 cUnicodeChar, EHTMLKeyModifiers eHTMLKeyModifiers );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
cUnicodeChar | uint32 | Punto de código del carácter Unicode de la tecla pulsada; puede haber varios caracteres por pulsación. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Se debe establecer como una máscara de bits de las teclas modificadoras que está pulsado el usuario. |
cUnicodeChar es el punto de código del carácter Unicode de la tecla pulsada (puede haber varios caracteres por pulsación)
KeyDown
void KeyDown( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
nNativeKeyCode | uint32 | Valor del keycode virtual del SO. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Se debe establecer como una máscara de bits de las teclas modificadoras que está pulsado el usuario. |
Interacciones de teclado. El keycode nativo es el código de tecla virtual del SO.
KeyUp
void KeyUp( HHTMLBrowser unBrowserHandle, uint32 nNativeKeyCode, EHTMLKeyModifiers eHTMLKeyModifiers );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
nNativeKeyCode | uint32 | Valor del keycode virtual del SO. |
eHTMLKeyModifiers | EHTMLKeyModifiers | Se debe establecer como una máscara de bits de las teclas modificadoras que está pulsando el usuario. |
LoadURL
void LoadURL( HHTMLBrowser unBrowserHandle, const char *pchURL, const char *pchPostData );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie en la que se va a cargar este URL. |
pchURL | const char * | El URL a cargar. |
pchPostData | const char * | Envía opcionalmente una solicitud POST con estos datos; se debe establecer como NULL si no se van a enviar datos. |
Navega al URL especificado.
Si
pchPostData
contiene datos para enviar en una solicitud POST, los datos deben formatearse como:
name1=value1&name2=value2
.
Puedes cargar cualquier esquema de URI compatible con Chromium Embedded Framework, entre otros:
http://
,
https://
,
ftp://
y
file:///
. Si no se especifica ningún esquema, se utiliza
http://
.
Devuelve: void
Activa la función callback
HTML_StartRequest_t.
MouseDoubleClick
void MouseDoubleClick( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
eMouseButton | EHTMLMouseButton | Botón del ratón con el que se ha hecho doble clic. |
Indica a una superficie HTML que se ha hecho doble clic con un botón del ratón.
El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a
MouseMove.
MouseDown
void MouseDown( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
eMouseButton | EHTMLMouseButton | Botón del ratón que se ha pulsado. |
Indica a una superficie HTML que se ha pulsado un botón del ratón.
El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a
MouseMove.
MouseMove
void MouseMove( HHTMLBrowser unBrowserHandle, int x, int y );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
x | int | Coordenada X (ancho) en píxeles relativa a la posición de la superficie HTML. (0, 0) es la parte superior izquierda. |
y | int | Coordenada Y (alto) en píxeles relativa a la posición de la superficie HTML. (0, 0) es la parte superior izquierda. |
Indica a la superficie HTML dónde se encuentra el ratón.
MouseUp
void MouseUp( HHTMLBrowser unBrowserHandle, EHTMLMouseButton eMouseButton );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
eMouseButton | EHTMLMouseButton | Botón del ratón que se ha soltado. |
Indica a una superficie HTML que se ha soltado un botón del ratón.
El clic se producirá donde la superficie cree que se encuentra el ratón, según la posición que tenía la última vez que se llamó a
MouseMove.
MouseWheel
void MouseWheel( HHTMLBrowser unBrowserHandle, int32 nDelta );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie a la que se va a enviar la interacción. |
nDelta | int32 | Número de píxeles a desplazar. |
Indica a la superficie HTML que la rueda del ratón se ha movido.
PasteFromClipboard
void PasteFromClipboard( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie en la que se va a pegar. |
Pega el contenido del portapapeles local en la página actual de una superficie HTML.
Reload
void Reload( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que se va a recargar. |
Actualiza la página actual.
Lo más probable es que la recarga utilice la caché local en lugar usar la red. Esto equivale a pulsar F5 o Ctrl+R en el navegador.
RemoveBrowser
void RemoveBrowser( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle del navegador que se va a liberar. |
Es necesario hacer esta llamada al terminar de usar la interfaz para liberar los recursos asociados.
En caso contrario, ¡habrá una pérdida de memoria!
SetBackgroundMode
void SetBackgroundMode( HHTMLBrowser unBrowserHandle, bool bBackgroundMode );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que se va establecer en modo de segundo plano. |
bBackgroundMode | bool | Activar o desactivar el modo de segundo plano. |
Activa o desactiva un modo de segundo plano con bajo consumo de recursos, en el que se limita el uso de JavaScript y los temporizadores de volver a dibujar, se purgan los recursos de memoria de forma más agresiva y se ponen en pausa los elementos de audio y vídeo.
Cuando el modo de segundo plano está habilitado, todos los objetos de vídeo y audio HTML5 ejecutarán ".pause()" y obtendrán la propiedad "._ steam_background_paused = 1".
Cuando el modo en segundo plano está deshabilitado, cualquier objeto de vídeo o audio que contenga esa propiedad, se reanudará con ".play()".
SetCookie
void SetCookie( const char *pchHostname, const char *pchKey, const char *pchValue, const char *pchPath = "/", RTime32 nExpires = 0, bool bSecure = false, bool bHTTPOnly = false );
Nombre | Tipo | Descripción |
pchHostname | const char * | El nombre de host del servidor en el que establecer la cookie. (atributo "Host") |
pchKey | const char * | El nombre de la cookie que se va a establecer. |
pchValue | const char * | El valor de la cookie que se va a establecer. |
pchPath | const char * | Establece el atributo "Path" en la cookie. Se puede usar para restringir la cookie a una ruta específica del dominio. por ejemplo, "/accounts" |
nExpires | RTime32 | Establece el atributo 'Expires' de la cookie en la marca de tiempo especificada en formato de tiempo Unix (segundos transcurridos desde el 1 de enero de 1970). |
bSecure | bool | Establece el atributo "Secure". |
bHTTPOnly | bool | Establece el atributo "HttpOnly". |
Establece una cookie para un nombre de host específico.
Puedes leer más sobre los detalles específicos de la configuración de cookies aquí en
wikipedia.
SetHorizontalScroll
void SetHorizontalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie en la que se va a establecer la posición de desplazamiento horizontal. |
nAbsolutePixelScroll | uint32 | La posición absoluta en píxeles a la que desplazarse. 0 es la izquierda y HTML_HorizontalScroll_t.unScrollMax es el lado derecho. |
Desplaza la página actual horizontalmente.
Devuelve: void
Activa la función callback
HTML_HorizontalScroll_t.
Véase también: HTML_HorizontalScroll_t,
SetVerticalScroll,
HTML_VerticalScroll_tSetKeyFocus
void SetKeyFocus( HHTMLBrowser unBrowserHandle, bool bHasKeyFocus );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que va a recibir el foco del teclado. |
bHasKeyFocus | bool | ¿Activar o desactivar recibir el foco del teclado? |
Indica a una superficie HTML si tiene el foco del teclado. Entre otras cosas, controla si se muestra el cursor parpadeante de texto I en cajas de texto.
SetPageScaleFactor
void SetPageScaleFactor( HHTMLBrowser unBrowserHandle, float flZoom, int nPointX, int nPointY );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie que se va a aumentar. |
flZoom | float | La cantidad a ampliar, puede variar desde 1 (100 % y el valor predeterminado) hasta 2 (200 %). |
nPointX | int | Punto X, en píxeles, sobre el que se va a ampliar. Si es indiferente, se usa 0. |
nPointY | int | Punto Y, en píxeles, sobre el que se va a ampliar. Si es indiferente, se usa 0. |
Amplía la página actual de una superficie HTML.
El factor de escala actual está disponible en
HTML_NeedsPaint_t.flPageScale
,
HTML_HorizontalScroll_t.flPageScale
y
HTML_VerticalScroll_t.flPageScale
.
SetSize
void SetSize( HHTMLBrowser unBrowserHandle, uint32 unWidth, uint32 unHeight );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie cuyo tamaño se va a establecer. |
unWidth | uint32 | Ancho de la superficie en píxeles. |
unHeight | uint32 | Altura de la superficie en píxeles. |
Establece el tamaño de una superficie en píxeles.
SetVerticalScroll
void SetVerticalScroll( HHTMLBrowser unBrowserHandle, uint32 nAbsolutePixelScroll );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie en la que se va a establecer la posición de desplazamiento vertical. |
nAbsolutePixelScroll | uint32 | La posición absoluta en píxeles a la que desplazarse. 0 es la parte superior y HTML_VerticalScroll_t.unScrollMax es la parte inferior. |
Desplaza la página actual verticalmente.
Devuelve: void
Activa la función callback
HTML_VerticalScroll_t.
Véase también: HTML_VerticalScroll_t,
SetHorizontalScroll,
HTML_HorizontalScroll_tShutdown
bool Shutdown();
Cierra la interfaz iSteamHTMLSurface, de manera que se liberan la memoria y los handle.
DEBES llamar a esta función cuando hayas terminado de usar esta interfaz para prevenir pérdidas de memoria y de handles. Después de llamarla, todas las funciones proporcionadas en esta interfaz fallarán hasta que llames a
Init para reinicializar nuevamente.
Devuelve: bool
Siempre devuelve
true.
StopFind
void StopFind( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie en la que se van a detener los resultados de la búsqueda. |
Cancela una búsqueda que se está ejecutando.
Véase también: FindStopLoad
void StopLoad( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie cuya carga se va parar. |
Detiene la carga de la página HTML actual.
ViewSource
void ViewSource( HHTMLBrowser unBrowserHandle );
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie cuyo código fuente se quiere visualizar. |
Abre el código fuente HTML de la página actual en el editor de texto predeterminado; se usa para la depuración.
Funciones callback
Estas son funciones callback que se activan al llamar a
SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de
ISteamHTMLSurface
.
HTML_BrowserReady_t
Se ha creado un nuevo navegador y está listo para usarse.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle del navegador que se acaba de crear; se puede usar con las llamadas futuras a ISteamHTMLSurface. |
Funciones asociadas: CreateBrowserHTML_CanGoBackAndForward_t
Se llama a esta función cuando el estado del historial de páginas cambia su capacidad de avanzar y retroceder.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
bCanGoBack | bool | Indica si es posible retroceder. |
bCanGoForward | bool | Indica si es posible avanzar. |
HTML_ChangedTitle_t
Se llama a esta función cuando la página actual del navegador obtiene un título nuevo.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchTitle | const char * | El nuevo título de la página. |
HTML_CloseBrowser_t
Se llama cuando el navegador recibe una solicitud para cerrarse a través de una interacción del usuario; generalmente es una llamada a la función
window.close()
de JavaScript.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
HTML_FileOpenDialog_t
Se llama cuando una superficie de navegador ha recibido un cuadro de diálogo de apertura de archivo a partir de un
<input type="file">
clic o similar. Debes llamar a
FileLoadDialogResponse con el(los) archivo(s) que el usuario selecciona.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie que se está navegando. |
pchTitle | const char * | El nombre del cuadro de diálogo. (por ejemplo, "Cargar imágenes") |
pchInitialFile | const char * | El nombre de archivo que la página quiere que establezcas de forma predeterminada. Puede ser que esté esperando un archivo con ese nombre o que se trate del archivo que el usuario ha subido anteriormente. |
HTML_FinishedRequest_t
Se llama a esta función cuando un navegador ha terminado de cargar una página.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función. |
pchURL | const char * | El URL que se ha cargado. |
pchPageTitle | const char * | El título de la página que se ha cargado. |
HTML_HideToolTip_t
Se llama a esta función cuando un navegador quiere ocultar una descripción emergente.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
HTML_HorizontalScroll_t
Aporta detalles sobre la visibilidad y el tamaño de la barra de desplazamiento horizontal.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
unScrollMax | uint32 | Desplazamiento horizontal máximo. |
unScrollCurrent | uint32 | Posición actual en el desplazamiento horizontal. |
flPageScale | float | La escala de la página actual. |
bVisible | bool | Si la barra de desplazamiento horizontal es visible. |
unPageSize | uint32 | Ancho total de la página en píxeles. |
Funciones asociadas: SetHorizontalScrollHTML_JSAlert_t
Se llama a esta función cuando el navegador quiere mostrar un cuadro de diálogo de alerta de JavaScript. Llama a
JSDialogResponse cuando el usuario lo descarta o si quieres ignorarlo inmediatamente.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchMessage | const char * | El mensaje del cuadro de diálogo. |
HTML_JSConfirm_t
Se llama a esta función cuando el navegador quiere mostrar un cuadro de diálogo de confirmación de JavaScript. Llama a
JSDialogResponse cuando el usuario lo descarta o para ignorarlo inmediatamente.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchMessage | const char * | El mensaje del cuadro de diálogo. |
HTML_LinkAtPosition_t
Resultado de una llamada a
GetLinkAtPosition Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
x | uint32 | No se usa. |
y | uint32 | No se usa. |
pchURL | const char * | El URL encontrado en esta posición. NULL si no se encontró ningún enlace. |
bInput | bool | ¿La posición es un campo de entrada? |
bLiveLink | bool | |
Funciones asociadas: GetLinkAtPositionHTML_NeedsPaint_t
Se llama a esta función cuando una superficie de navegador tiene un renderizado pendiente. Aquí es donde los datos de la imagen se representan en la pantalla.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pBGRA | const char * | Un puntero a los datos de la imagen de B8G8R8A8 para esta superficie, válido hasta que SteamAPI_RunCallbacks sea llamada de nuevo. |
unWide | uint32 | El ancho total de la textura pBGRA . |
unTall | uint32 | La altura total de la textura pBGRA . |
unUpdateX | uint32 | Desplazamiento horizontal del rectángulo afectado por esta actualización. |
unUpdateY | uint32 | Desplazamiento vertical del rectángulo afectado por esta actualización. |
unUpdateWide | uint32 | Ancho del rectángulo afectado por esta actualización. |
unUpdateTall | uint32 | La altura del rectángulo afectado por esta actualización. |
unScrollX | uint32 | Posición de desplazamiento horizontal en la que estaba el navegador cuando se representó esta textura. |
unScrollY | uint32 | Posición de desplazamiento vertical en la que estaba el navegador cuando se representó esta textura. |
flPageScale | float | Factor de escala que tenía el navegador cuando se representó esta textura. |
unPageSerial | uint32 | Incrementado con cada nueva carga de página; úsalo para evitar que haga representaciones al navegar a páginas nuevas. |
HTML_NewWindow_t
Un navegador ha creado una ventana HTML nueva.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchURL | const char * | URL para cargar en la nueva ventana. |
unX | uint32 | Coordenada X de la página en la que se mostrará el elemento emergente. |
unY | uint32 | Coordenada Y de la página en la que se mostrará el elemento emergente. |
unWide | uint32 | El ancho total de la textura pBGRA. |
unTall | uint32 | La altura total de la textura pBGRA. |
unNewWindow_BrowserHandle | HHTMLBrowser | Handle de la superficie de la nueva ventana. |
HTML_OpenLinkInNewTab_t
El navegador ha solicitado cargar un URL en una pestaña nueva.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchURL | const char * | URL que el navegador quiere cargar. |
HTML_SearchResults_t
Resultados de una búsqueda.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
unResults | uint32 | Número de resultados obtenidos que coinciden con los criterios. |
unCurrentMatch | uint32 | El ordinal de la coincidencia actual relativa a unResults . |
Funciones asociadas: FindHTML_SetCursor_t
Se llama a esta función cuando un navegador quiere cambiar el cursor del ratón.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
eMouseCursor | uint32 | El EMouseCursor para mostrar. |
HTML_ShowToolTip_t
Se llama a esta función cuando un navegador quiere mostrar una descripción emergente.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchMsg | const char * | Texto de la descripción emergente que se quiere mostrar. |
HTML_StartRequest_t
Se llama a esta función cuando un navegador desea acceder a una nueva página.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | El handle de la superficie que se está navegando. |
pchURL | const char * | URL al que quieres navegar. |
pchTarget | const char * | El tipo de destino del enlace html (es decir, _blank, _self, _parent, _top). |
pchPostData | const char * | Cualquier dato enviado en la solicitud. |
bIsRedirect | bool | True si fue un redireccionamiento http/html desde la última solicitud de carga. |
Funciones asociadas: LoadURLHTML_StatusText_t
Se llama a esta función cuando un navegador quiere que se muestre un mensaje informativo. Esto se utiliza más comúnmente cuando se pasa el cursor sobre un vínculo.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchMsg | const char * | Texto del mensaje de estado para mostrar. |
HTML_UpdateToolTip_t
Se llama a esta función cuando se ha actualizado el texto de una descripción emergente existente.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchMsg | const char * | El nuevo texto de la descripción emergente. |
HTML_URLChanged_t
Se llama a esta función cuando el navegador está accediendo a un nuevo URL
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
pchURL | const char * | URL al que está accediendo el navegador. |
pchPostData | const char * | Cualquier dato enviado para la solicitud, NULL si no hubo ninguno. |
bIsRedirect | bool | True si esto fue un redireccionamiento http/html desde la última solicitud de carga, de lo contrario, false. |
pchPageTitle | const char * | El título de la página. |
bNewNavigation | bool | Esto es true si es una página nueva y no una llamada a la API del historial del navegador. |
HTML_VerticalScroll_t
Aporta detalles sobre la visibilidad y el tamaño de la barra de desplazamiento vertical.
Nombre | Tipo | Descripción |
unBrowserHandle | HHTMLBrowser | Handle de la superficie para la que se llama a esta función callback. |
unScrollMax | uint32 | Desplazamiento vertical máximo. |
unScrollCurrent | uint32 | Posición actual en el desplazamiento vertical. |
flPageScale | float | La escala de la página actual. |
bVisible | bool | Si la barra de desplazamiento vertical es visible. |
unPageSize | uint32 | Altura total de la página en píxeles. |
Funciones asociadas: SetVerticalScrollEnums
Estas son enumeraciones definidas para usarse con ISteamHTMLSurface.
EHTMLKeyModifiers
Se utiliza para que el navegador sepa qué teclas se presionan con:
KeyChar,
KeyUp y
KeyDown. Estas marcas pueden añadirse conjuntamente usando el operador OR a nivel de bits.
Nombre | Valor | Descripción |
k_eHTMLKeyModifier_None | 0 | No se ha pulsado ningún modificador. |
k_eHTMLKeyModifier_AltDown | 1 << 0 | Una de las teclas Alt está pulsada. |
k_eHTMLKeyModifier_CtrlDown | 1 << 1 | Una de las teclas Ctrl está pulsada. |
k_eHTMLKeyModifier_ShiftDown | 1 << 2 | Una de las teclas Mayús está pulsada. |
EHTMLMouseButton
Se utiliza para que el navegador sepa qué teclas se presionan con:
MouseUp,
MouseDown y
MouseDoubleClick.
Nombre | Valor | Descripción |
eHTMLMouseButton_Left | 0 | El botón izquierdo está pulsado. |
eHTMLMouseButton_Right | 1 | El botón derecho está pulsado. |
eHTMLMouseButton_Middle | 2 | El botón central está pulsado. |
EMouseCursor
Esto contiene una lista de los cursores de ratón que la superficie HTML puede solicitar representar.
Nombre | Valor | Descripción |
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 | No muestra ningún cursor personalizado, solo el cursor por defecto. |
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 | Se emplea solo para iterar sobre todos los cursores. Los cursores personalizados comienzan a partir de este valor y hacia adelante. |
Typedefs
Estos son los typedef definidos para usarse con ISteamHTMLSurface.
Nombre | Tipo de base | Descripción |
HHTMLBrowser | uint32 | Representa un handle único para una superficie HTML. |
Constants
Estas son constantes definidas para usarse con ISteamHTMLSurface.
Nombre | Tipo | Valor | Descripción |
INVALID_HTMLBROWSER | uint32 | 0 | Indica que handle del navegador no es válido. Debes inicializar tus propios handle HHTMLBrowser con este valor y luego volver a establecerlo cuando la página se cierre. |
STEAMHTMLSURFACE_INTERFACE_VERSION | const char * | "STEAMHTMLSURFACE_INTERFACE_VERSION_003" | |