VkWebViewer(3)							VkWebViewer(3)

NAME    [Toc]    [Back]

     VkWebViewer - Web viewing component

INHERITS FROM    [Toc]    [Back]

     VkWebViewerBase : VkComponent, wvBrowser :	VkCallbackObject

HEADER FILE    [Toc]    [Back]

     #include <Vk/VkWebViewer.h>

PUBLIC PROTOCOL	SUMMARY
   Constructor/Destructor
	   VkWebViewer(const char *, VkComponent);
	   VkWebViewer(const char *, Widget);
	   VkWebViewer(const char *);
	   ~VkWebViewer();


   Navigation    [Toc]    [Back]
	   void	stopTransfer()
	   void	navigate(VkWebViewerDirection direction)
	   void	navigate(unsigned int index)
	   unsigned int	getStackDepth()


   Appearance    [Toc]    [Back]
	   void	setControls(Boolean)



   Accessing URLs and Files    [Toc]    [Back]
	   void	fetchUrl(const cstring&	url, const cstring& query,
		      const cstring& method, NavigationFlags nav);
	   void	fetchFile(const	cstring& filename, NavigationFlags nav);


   Loading control    [Toc]    [Back]
	   void	stopFetch()


   Miscellaneous    [Toc]    [Back]
	   void	setFollowLinks(Boolean f)
	   Boolean getFollowLinks()
	   void	notify(NotifyReason, const char* message);
	   void	postError(const	char*)

CLASS DESCRIPTION    [Toc]    [Back]

     This viewkit component provides a means for application which would like
     to	provide	web access from	within the application.	Many reasons for
     providing such access may have little to do with the web "per se."	 For
     example, this component can be used with a	form and the post method to



									Page 1






VkWebViewer(3)							VkWebViewer(3)



     obtain a license for a user from a	local or remote	server.	The component
     can be used to format text	and images in a	purely read-only fashion, or
     could be used to provide help to the user.	 See also VkWebViewerBase.

     The viewer	maintains a stack of visited links which can be	navigated, a
     cache which holds images and pages	visited	and which purges pages on a
     least recently used basis,	and a set of UI	controls thought to be
     familiar to the web user. The viewer provides an API which	allows the
     programmer	to control these features and uses a small number of X
     resources to control the aspects of the viewer which are modifiable by
     the programmer.

FUNCTION DESCRIPTIONS    [Toc]    [Back]

   void	navigate(VkWebViewerDirection direction)
     The visited URLs form a stack. By calling navigate, you can move through
     the stack.	The values for direction are:

	  SG_FIRST,
	  SG_LAST,
	  SG_PREV,
	  SG_NEXT



   void	navigate(unsigned int index)
     The visited URLs form a stack. By calling navigate, you can move through
     the stack.	This form of navigate lets you go directly to a	particular
     item on the stack.	getStackDepth()	can be used to find the	upper bound on
     index.


   void	setControls(Boolean show)
     This method allows	the programmer to control the UI shown.	If this	is
     true (the default)	then all the controls are shown. If false, a more
     minimal set is shown. This	method is primarily for	use with the media
     warehouse's media viewer component. This can also be controlled by	the
     resource "controls".


   unsigned int	getStackDepth()
     This method returns the current upper bound on the	visited	URL stack.
     The stack includes	all URLs visited including the one currently being
     viewed.  The current URL being viewed is at the stack depth less one.

Bugs and Limitations    [Toc]    [Back]

     See VkWebViewerBase.3 for details.


									PPPPaaaaggggeeee 2222