QHTM API Reference and User Guide

For a quick introduction of how to use QHTM see the quick start page.

To make use of QHTM in programming languages other than C/C++ you will need to know how to create a window from a window class name, and how to send messages to a window and how to call a "C" function in a DLL.

How to

Use QHTM as a simple hyperlink control

A step-by-step guide for using QHTM as a simple hyperlink control on a dialog.

Giving HTML to QHTM

A discussion of the various methods of actually displaying HTML including how QHTM locates images.

Add borders

Add borders to a QHTM control

Printing

Print using standard API printing mechanisms

Hyperlinks

A method of handling hyperlinks within your applications

Linking with the library

Describes issues regarding linking to QHTM

Using QHTM with VC5

Making a link library for use within VC5

Catch hyperlinks

Catch hyperlinks and run your own code for them

Function Reference

QHTM_Initialize

Initialise the library

QHTM_EnableCooltips

Enable and disable tooltips within an application

QHTM_SetResources

Set the resource used for the 'hand' pointer and the 'no image' bitmap

QHTM_PrintCreateContext

Create a print context specifying a zoom level

QHTM_PrintDestroyContext

Destroy a print context

QHTM_PrintSetText

Set the print context text using some in memory text block

QHTM_PrintSetTextFile

Set the print context text using a file

QHTM_PrintSetTextResource

Set the print context text using a resource

QHTM_PrintLayout

Layout the HTML and determine the number of pages required

QHTM_PrintPage

Print an entire page

QHTM_PrintGetHTMLHeight

Measure some in memory text prior to printing

QHTM_PrintSetImageCallback

Set the image callback for a print context

QHTM_MessageBox

A drop in replacement for the MessageBox API, except we display HTML for the text!

QHTM_SetHTMLButton

Change a standard push button to allow it to contain HTML with a single function call.

QHTM_SetHTMLListbox

Change a standard listbox control to allow it to contain HTML with a single function call.

QHTM_GetHTMLHeight

Measure the height of HTML given a constraining width.

QHTM_RenderHTML

Render HTML onto a device context.

QHTM_RenderHTMLRect

Render HTML onto a device context and confined within a rectangle.

QHTM Types

funcQHTMImageCallback

Pointer to function to supply images to QHTM

funcQHTMBitmapCallback

Pointer to function to supply HBITMAP's to QHTM

funcQHTMResourceCallback

Pointer to function to supply any resource to QHTM. When QHTM needs a HTML file, image, or any other file it will call this callback.

funcQHTMFORMCallback

Pointer to function to receive form POST information. When the user submits a form QHTM gathers the form data and sends it to this callback.

struct QHTMFORMSubmit

Structure that QHTM uses to send for POST data to your application.

class CQHTMImageABC

Image callback abstract base class class

struct QHTM_LINK_INFO

Structure used when asking QHTM for hyperlink information

Message Reference

A list of the messages that can be sent to QHTM and what they mean. All of the messages have message cracker APIs too.

QHTM_LOAD_FROM_RESOURCE

Load some HTML from resources into a QHTM window

QHTM_LOAD_FROM_FILE

Load some HTML from a file into a QHTM window

QHTM_SET_OPTION

Set one of the QHTM options

QHTM_GET_OPTION

Get one of the QHTM options

QHTM_GOTO_LINK

Force QHTM to scroll to a given named link target within the current document

QHTM_GET_SCROLL_POS

Get the current scroll position within the current document

QHTM_SET_SCROLL_POS

Set the current scroll position within the current document

QHTM_GET_HTML_TITLE_LENGTH

Get the length of the title of the current document

QHTM_GET_HTML_TITLE

Get the title of the current document

QHTM_GET_DRAWN_SIZE

Get the drawn size of thw HTML within QHTM window

QHTM_ADD_HTML

Add HTML to the current QHTM document.

QHTM_GET_LINK_FROM_POINT

Get hyperlink information from a point.