home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / VkWebViewer.z / VkWebViewer
Encoding:
Text File  |  1998-10-30  |  5.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrr((((3333))))                                                  VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrr((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkWebViewer - Web viewing component
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkWebViewerBase : VkComponent, wvBrowser : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkWebViewer.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkWebViewer(const char *, VkComponent);
  20.            VkWebViewer(const char *, Widget);
  21.            VkWebViewer(const char *);
  22.            ~VkWebViewer();
  23.  
  24.  
  25.    NNNNaaaavvvviiiiggggaaaattttiiiioooonnnn
  26.            void stopTransfer()
  27.            void navigate(VkWebViewerDirection direction)
  28.            void navigate(unsigned int index)
  29.            unsigned int getStackDepth()
  30.  
  31.  
  32.    AAAAppppppppeeeeaaaarrrraaaannnncccceeee
  33.            void setControls(Boolean)
  34.  
  35.  
  36.  
  37.    AAAAcccccccceeeessssssssiiiinnnngggg UUUURRRRLLLLssss aaaannnndddd FFFFiiiilllleeeessss
  38.            void fetchUrl(const cstring& url, const cstring& query,
  39.                       const cstring& method, NavigationFlags nav);
  40.            void fetchFile(const cstring& filename, NavigationFlags nav);
  41.  
  42.  
  43.    LLLLooooaaaaddddiiiinnnngggg ccccoooonnnnttttrrrroooollll
  44.            void stopFetch()
  45.  
  46.  
  47.    MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss
  48.            void setFollowLinks(Boolean f)
  49.            Boolean getFollowLinks()
  50.            void notify(NotifyReason, const char* message);
  51.            void postError(const char*)
  52.  
  53.  
  54.  
  55. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  56.      This viewkit component provides a means for application which would like
  57.      to provide web access from within the application. Many reasons for
  58.      providing such access may have little to do with the web "per se."  For
  59.      example, this component can be used with a form and the post method to
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrr((((3333))))                                                  VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrr((((3333))))
  71.  
  72.  
  73.  
  74.      obtain a license for a user from a local or remote server. The component
  75.      can be used to format text and images in a purely read-only fashion, or
  76.      could be used to provide help to the user.  See also VkWebViewerBase.
  77.  
  78.      The viewer maintains a stack of visited links which can be navigated, a
  79.      cache which holds images and pages visited and which purges pages on a
  80.      least recently used basis, and a set of UI controls thought to be
  81.      familiar to the web user. The viewer provides an API which allows the
  82.      programmer to control these features and uses a small number of X
  83.      resources to control the aspects of the viewer which are modifiable by
  84.      the programmer.
  85.  
  86.  
  87. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  88.    vvvvooooiiiidddd nnnnaaaavvvviiiiggggaaaatttteeee((((VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrDDDDiiiirrrreeeeccccttttiiiioooonnnn ddddiiiirrrreeeeccccttttiiiioooonnnn))))
  89.      The visited URLs form a stack. By calling navigate, you can move through
  90.      the stack. The values for direction are:
  91.  
  92.           SG_FIRST,
  93.           SG_LAST,
  94.           SG_PREV,
  95.           SG_NEXT
  96.  
  97.  
  98.  
  99.    vvvvooooiiiidddd nnnnaaaavvvviiiiggggaaaatttteeee((((uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt iiiinnnnddddeeeexxxx))))
  100.      The visited URLs form a stack. By calling navigate, you can move through
  101.      the stack. This form of navigate lets you go directly to a particular
  102.      item on the stack. getStackDepth() can be used to find the upper bound on
  103.      index.
  104.  
  105.  
  106.    vvvvooooiiiidddd sssseeeettttCCCCoooonnnnttttrrrroooollllssss((((BBBBoooooooolllleeeeaaaannnn sssshhhhoooowwww))))
  107.      This method allows the programmer to control the UI shown. If this is
  108.      true (the default) then all the controls are shown. If false, a more
  109.      minimal set is shown. This method is primarily for use with the media
  110.      warehouse's media viewer component. This can also be controlled by the
  111.      resource "controls".
  112.  
  113.  
  114.    uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ggggeeeettttSSSSttttaaaacccckkkkDDDDeeeepppptttthhhh(((())))
  115.      This method returns the current upper bound on the visited URL stack.
  116.      The stack includes all URLs visited including the one currently being
  117.      viewed.  The current URL being viewed is at the stack depth less one.
  118.  
  119.  
  120. BBBBuuuuggggssss aaaannnndddd LLLLiiiimmmmiiiittttaaaattttiiiioooonnnnssss
  121.      See VkWebViewerBase.3 for details.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.