Description |
XWebView is a high-level control which gives you the functionality of a web-browser. It uses the the WebExplorer-display capabilitys so you can use the EMail and News services too.
To use the control in your application:
XWebView |
| XWindow * owner | the owner window |
| XRect * rect | rectangle |
| USHORT id | the window-ID |
Constructs a web-control
GetExtMap |
| char * extension | file-extension | |||
| XString * MIME | buffer for the type of MIME | |||
| SHORT& format | buffer for format, on result you may receive:
|
BOOL result
Get an association of a file-extension with a MIME-type
GetViewer |
char * MIME type of MIME
XString * program buffer which will hold the registered program.
BOOL result
Get a viewer for a specific MIME-type
SetExtMap |
| char * extension | file-extension | |||
| char * MIME | type of MIME | |||
| SHORT format | format:
|
BOOL result
Associate a file-extension with a MIME-type
SetViewer |
char * MIME type of MIME
char * program program to register.
BOOL result
Register a viewer for a specific MIME-type
GetPointer |
| LONG pointerType | the pointer to request:
|
OOL_POINTERHNDLE handle of the pointer.
Get a pointer.
SetPointer |
| OOL_POINTERHANDLE | handle of the pointer to set | ||||
| LONG pointerType | the pointer to set:
|
BOOL success
Get a pointer.
GetAnchorState |
| char * anchor | name of the anchor | ||
| LONG& state | buffer for the state to the anchor, you may receive:
|
BOOL result
Get the state of an anchor.
GetDocAnchor |
XString * buffer buffer to hold data.
BOOL result
Get the anchor of the document.
SetAnchorState |
| char * anchor | name of the anchor | ||
| LONG state | state to set:
|
BOOL result
Set the state of an anchor.
GetLastError |
LONG result
Get the last error-code.
GetLastLoadError |
LONG result
Get for the lasterror which occures when data was loaded.
HandleError |
ULONG errorCode char * errorMessage
Override this function to get information on runtime-errors
LoadProgress |
ULONG state, possible values are: WEB_CONNECT WEB_WAIT WEB_LOADDATA WEB_RENDER
Override this function to get information of progress of loading data
LoadResult |
ULONG result, possible values are: WEB_SUCCESS WEB_ERROR WEB_CANCELLED
Override this function to get information of the success of loading data.
IsLoading |
BOOL result
Get if the control is loading data.
Load |
char * url full qualified URL
BOOL reload TRUE=do not use cached data, FALSE=use cache
LONG result
Load data from the internet/intranet
SaveToFile |
| char * url | full qualified URL |
| char * file | full qualified path + filename |
| BOOL reload | TRUE=do not use cached data FALSE=use cache |
LONG result
Load data and save it to a file
StopLoading |
Stops loading data.
ButtonPressed |
| SHORT | buttonNumber |
| SHORT | xPosition in window-coordinates |
| SHORT | yPosition in window-coordinates |
Override this function to get information when a mouse-button was pressed.
GetDocTitle |
XString * buffer buffer to hold data.
BOOL result
Get the title of the document.
GetPos |
XPoint * in window-cordinates
XPoint * buffer bufer wich will hold the document-coordinates
LONG result
Calculate document-coordinates from window-coordinates (e.g. mouse-position).
Search |
| char* string | string to find. |
| XPoint * start | point in document-coordinates to start |
| XPoint * buffer | buffer which will hold coordinates of the result |
| BOOL forward | TRUE=search forward, FALSE=backward |
BOOL result
Search a string in the document.
SetOptions |
char * emailAddress your email address
char * newsServer the news-server to use
Setup options for EMail and News services.