home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Assembler / TFF-AOC.DMS / in.adf / Release3.1 / AutoDocs3.1.lha / doc / amigaguide_dtc.doc < prev    next >
Encoding:
Text File  |  1993-08-12  |  2.7 KB  |  111 lines
  1. TABLE OF CONTENTS
  2.  
  3. amigaguide.datatype/amigaguide.datatype
  4. amigaguide.datatype/amigaguide.datatypemigaguide.datatype/amigaguide.datatype
  5.  
  6.     NAME
  7.     amigaguide.datatype -- data type for AmigaGuide databases.
  8.  
  9.     FUNCTION
  10.     The amigaguide.datatype is the DataTypes class for AmigaGuide
  11.     databases.
  12.  
  13.     METHODS
  14.     OM_NEW -- Create a new AmigaGuide object.
  15.  
  16.     OM_GET -- Obtain the value of an attribute.
  17.  
  18.     OM_SET -- Set the values of multiple attributes.
  19.  
  20.     OM_UPDATE -- Update the values of multiple attributes.
  21.  
  22.     OM_DISPOSE -- Dispose of an AmigaGuide object.
  23.  
  24.     GM_LAYOUT -- Layout the object and notify the application of the
  25.         title and size.
  26.  
  27.     GM_HITTEST -- Determine if the object has been hit with the
  28.         mouse.
  29.  
  30.     GM_GOACTIVE -- Tell the object to go active.
  31.  
  32.     GM_HANDLEINPUT -- Handle input.
  33.  
  34.     GM_RENDER -- Cause the AmigaGuide database to render.
  35.  
  36.     DTM_GOTO -- Cause the AmigaGuide database to load and display
  37.         document.
  38.  
  39.     DTM_TRIGGER -- Trigger an event.
  40.  
  41.         STM_COMMAND - Invoke an AmigaGuide command.
  42.  
  43.         STM_CONTENTS - Display the table of contents.
  44.  
  45.         STM_INDEX - Display the index.
  46.  
  47.         STM_HELP - Display the help file.
  48.  
  49.         STM_RETRACE - Retrace.
  50.  
  51.         STM_BROWSE_PREV - Go to the previous sequential document.
  52.  
  53.         STM_BROWSE_NEXT - Go to the next sequential document.
  54.  
  55.     DTM_PROCLAYOUT -- Layout (remap) the AmigaGuide database on the
  56.         application's process.
  57.  
  58.     DTM_FRAMEBOX -- Obtain the display environment that the
  59.         AmigaGuide database requires.
  60.  
  61.     DTM_SELECT -- Select an area in the AmigaGuide database.
  62.  
  63.     DTM_CLEARSELECTED -- Deselect the selected area of the
  64.         AmigaGuide database.
  65.  
  66.     DTM_COPY -- Copy the selected area of the text to the clipboard
  67.         as FTXT.  If no area is selected, then the entire text
  68.         is copied.
  69.  
  70.     DTM_PRINT -- Print the selected area of the text.  If no area
  71.         is selected, then the entire text is printed.
  72.  
  73.     DTM_WRITE -- Write the selected area of the text to a file.
  74.         If no area is selected, then the entire text is saved.
  75.  
  76.     TAGS
  77.     DTA_TriggerMethods -- List of the trigger methods supported.
  78.  
  79.         Applicability is (G).
  80.  
  81.     DTA_Methods -- List of the methods supported.
  82.  
  83.         Applicability is (G).
  84.  
  85.     DTA_TextAttr (struct TextAttr *) -- Text attribute to use for
  86.         the AmigaGuide database.
  87.  
  88.         Applicability is (ISG).
  89.  
  90.     DTA_Name (STRPTR) -- Name of the AmigaGuide database.
  91.  
  92.         Applicability is (I).
  93.  
  94.     DTA_Handle (BPTR) -- File handle for the AmigaGuide database.
  95.  
  96.         Applicability is (I).
  97.  
  98.     DTA_NodeName (STRPTR) -- Document to display.
  99.  
  100.         Applicability is (I).
  101.  
  102.     TDTA_WordDelim (STRPTR) -- Characters used to deliminate words.
  103.  
  104.         Applicability is (IS).
  105.  
  106.     AGA_HelpGroup (ULONG) -- Help group that the AmigaGuide object
  107.         belongs in.
  108.  
  109.         Applicability is (I).
  110.  
  111.