home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / dev / mui / MCC_HTMLtext.lha / MCC_HTMLtext / Developer / AutoDocs / HTMLtext_mcc.doc
Encoding:
Text File  |  1997-02-28  |  4.3 KB  |  145 lines
  1. TABLE OF CONTENTS
  2.  
  3. HTMLtext.mcc/HTMLtext.mcc
  4. HTMLtext.mcc/MUIA_HTMLtext_Contents
  5. HTMLtext.mcc/MUIA_HTMLtext_OpenURLHook
  6. HTMLtext.mcc/MUIA_HTMLtext_Path
  7. HTMLtext.mcc/MUIA_HTMLtext_Title
  8. HTMLtext.mcc/MUIM_HTMLtext_URL
  9. HTMLtext.mcc/HTMLtext.mcc                           HTMLtext.mcc/HTMLtext.mcc
  10.  
  11.    COPYRIGHT
  12.  
  13.      HTMLtext.mcc
  14.      (C)opyright by Dirk Holtwick
  15.  
  16.      This product is Giftware and the source is available from
  17.      the author and may be used and modified with explicit permission
  18.      of the author Dirk Holtwick.
  19.  
  20.      The HTMLtext class may be used in every project.
  21.  
  22.    DECRIPTION
  23.      The HTMLtext class for MUI dispalys a subset of HTML in a virtual group.
  24.      You may put it into a ScrollgroupObject to move easier through
  25.      the text.
  26.  
  27.    AUTHOR
  28.      Dirk Holtwick
  29.      Grenzdicker Str. 13
  30.      D-47665 Sonsbeck
  31.      dirco@uni-duisburg.de
  32.      http://fsrinfo.uni-duisburg.de/~dirk/
  33.  
  34. HTMLtext.mcc/MUIA_HTMLtext_Contents       HTMLtext.mcc/MUIA_HTMLtext_Contents
  35.  
  36.    NAME
  37.      MUIA_HTMLtext_Contents -- (V1 ) [ISG], STRPTR
  38.  
  39.    FUNCTION
  40.      String to be displayed in the HTMLtext object.
  41.  
  42.      This string may content HTML tags and the equivalent
  43.      closing tags (e.g. <b>..</b>. Not supported tags will not have any
  44.      effect to the output. The structure defined by the HTML specifications
  45.      have to be respected. See example for a simple HTML demo text.
  46.      To know about the supported tags and attributes please refer to
  47.      the documentation of the HTMLtext class.
  48.  
  49.      See also further documentation of the HTML language.
  50.  
  51.    EXAMPLE
  52.      MUIA_HTMLtext_Contents,
  53.         "<html>"
  54.         "  <head>"
  55.         "     <title>Example</title>"
  56.         "  </head>"
  57.         "  <body>"
  58.         "     <p>A simple example for the HTML class</p>"
  59.         "  </body>"
  60.         "</html>"
  61.  
  62.    BUG
  63.       If you set a text with background pattern in a not opened
  64.       window the background may appear crippled. (Don't ask me why!)
  65.  
  66.    SEE ALSO
  67.       MUIM_LoadContents, MUIA_Path, MUIA_Title
  68.  
  69. HTMLtext.mcc/MUIA_HTMLtext_OpenURLHook HTMLtext.mcc/MUIA_HTMLtext_OpenURLHook
  70.  
  71.    NAME
  72.      MUIA_HTMLtext_OpenURLHook -- [IS.], struct Hook *
  73.  
  74.    FUNCTION
  75.      This hook will be called, always when an URL has to be loaded
  76.      whose protocol is not supported. These URL's may come from
  77.      hyperlinks, image or else.
  78.      The hook function will receive a pointer to a structure described bellow
  79.      in the register a1. In a0 is a pointer to the calling hook and in a2
  80.      a pointer to the calling object.
  81.  
  82.         struct
  83.         {
  84.            char *URL;
  85.            char *TmpFile;
  86.         };
  87.  
  88.      The member 'URL' contains the full name of the URL. 'TmpFile' is the
  89.      name of the file, where to the contents of the URL have to be written.
  90.      HTMLtext will delete this file after use. You have to return FALSE if
  91.      the loading failed.
  92.  
  93.    EXAMPLE
  94.      moreHTML.c
  95.  
  96.    BUGS
  97.      This attribute doesn't work very well. It is better to avoid it,
  98.      until it works stabile in a later version. Image loading isn't done
  99.      by this routine,yet.
  100.  
  101.    SEE ALSO
  102.      MUIA_HTMLtext_URL
  103.  
  104. HTMLtext.mcc/MUIA_HTMLtext_Path               HTMLtext.mcc/MUIA_HTMLtext_Path
  105.  
  106.    NAME
  107.      MUIA_HTMLtext_Path -- (V1 ) [ISG], STRPTR
  108.  
  109.    FUNCTION
  110.      Sets the path to the used document. This value will be used, if
  111.      there are images to load or links to follow and they not have
  112.      a full path. If you use MUIA_HTMLtext_LoadContents, the path will
  113.      be automatically set.
  114.  
  115.    SEE ALSO
  116.      MUIA_HTMLtext_LoadContents
  117.  
  118. HTMLtext.mcc/MUIA_HTMLtext_Title             HTMLtext.mcc/MUIA_HTMLtext_Title
  119.  
  120.    NAME
  121.      MUIA_HTMLtext_Title -- (V1 ) [..G], STRPTR
  122.  
  123.    FUNCTION
  124.      Gets the title of the document currently active. The title has
  125.      to be specified in the text between <title> and </title> tags.
  126.  
  127.    SEE ALSO
  128.      MUIA_HTMLtext_Contents
  129.  
  130. HTMLtext.mcc/MUIM_HTMLtext_URL                 HTMLtext.mcc/MUIM_HTMLtext_URL
  131.  
  132.    NAME
  133.      MUIA_HTMLtext_URL -- [ISG], STRPTR
  134.  
  135.    FUNCTION
  136.      Name of an URL to be loaded. If the URL is of an not supported
  137.      protocol, the MUIA_HTMLtext_OpenURLHook will be called.
  138.  
  139.      The only supported protocol, yet, is "file:///". Names without
  140.      any protocol specification will be handled as normal local filenames.
  141.  
  142.    SEE ALSO
  143.       MUIA_HTMLtext_OpenURLHook, MUIM_LoadContents, MUIA_Path, MUIA_Title
  144.  
  145.