home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 72 / af072sub.adf / bindt / bindt.lha / binarydt / doc / binary_dtc.doc < prev   
Encoding:
Text File  |  1995-02-19  |  3.2 KB  |  98 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. binary.datatype/binary.datatype
  6.  
  7.  
  8. binary.datatype/binary.datatype                binary.datatype/binary.datatype
  9.  
  10.     NAME
  11.         binary.datatype -- data type for any binary file
  12.  
  13.     FUNCTION
  14.         The binary data type, a base-class of all binary data, is used to
  15.         load any binary file and displays the contents of the file in hex
  16.         format.
  17.  
  18.     PREFS
  19.         The data type tries to load the prefs file first from
  20.         "PROGDIR:Prefs/binary.prefs","PROGDIR:binary.prefs" and then
  21.         "ENV:DataTypes/binary.prefs" on each OM_NEW method to set up the
  22.         attributes !
  23.         Up from version 39.10 it uses the ReadArgs() function to parse the
  24.         prefs file. The template is :
  25.  
  26.         NOASCII/S,NOWRAP/S,NONE/S,BYTE/S,WORD/S,LONG/S,BPL=BYTESPERLINE/N/K
  27.  
  28.         NOASCII   - sets BDTA_ShowASCII to FALSE
  29.         NOWRAP    - sets BDTA_DisplayWrap to FALSE
  30.         NONE      - sets BDTA_DisplayHex to BDTDH_NONE
  31.         BYTE      - sets BDTA_DisplayHex to BDTDH_BYTE
  32.         WORD      - sets BDTA_DisplayHex to BDTDH_WORD
  33.         LONG      - sets BDTA_DisplayHex to BDTDH_LONG
  34.         BYTESPERLINE <bpl> or
  35.         BPL <bpl> - sets BDTA_BytesPerLine to <bpl> bytes
  36.  
  37.         The options can be on several lines !
  38.  
  39.     METHODS
  40.         OM_NEW -- Create a new text object from a binary file in hex mode.
  41.  
  42.         OM_DISPOSE -- dispose a object
  43.  
  44.         OM_GET -- get a attribute of the object
  45.  
  46.         OM_SET -- set attributes of the object
  47.  
  48.         OM_UPDATE -- update some attributes of the object
  49.  
  50.         GM_LAYOUT -- Method to layout the hex text
  51.  
  52.         GM_RENDER -- draw the object
  53.  
  54.         DTM_WRITE -- DTWM_RAW mode is supported
  55.  
  56.         DTM_PRINT -- prints the hex text
  57.  
  58.     TAGS
  59.         BDTA_Buffer -- (UBYTE *) pointer to the buffer, which should be
  60.             displayed.
  61.             Applicability is (ISG).
  62.  
  63.         BDTA_BufferLen -- (ULONG) length of the buffer supplied with
  64.             BDTA_Buffer tag. This must be given if the buffer tag is
  65.             specified.
  66.             Applicability is (ISG).
  67.  
  68.         BDTA_BytesPerLine -- (UWORD) number of bytes per line.
  69.             If BDTA_DisplayHex is BDTDH_WORD it must be a multiply of 2,
  70.             if it is BDTDH_LONG it must be a multiply of 4 !
  71.             Default is 32.
  72.             Applicability is (ISGNU).
  73.  
  74.         BDTA_DisplayHex -- (UWORD) type of the display. The following types
  75.             are supported : BDTDH_NONE  - displays no hex values
  76.                             BDTDH_BYTE  - displays each byte in hex ( 8 bit)
  77.                             BDTDH_WORD  - displays each word in hex (16 bit)
  78.                             BDTDH_LONG  - displays each long in hex (32 bit)
  79.             Default is BDTDH_LONG.
  80.             Applicability is (ISGNU).
  81.  
  82.         BDTA_ShowASCII -- (BOOL) display at the end of the line the
  83.             appropriate ASCII string !
  84.             Default is TRUE.
  85.             Applicability is (ISGNU).
  86.  
  87.         BDTA_DisplayWrap -- (BOOL) the BDTA_BytesPerLine are ignored and the
  88.             byte number is retrieved from the object width !
  89.             Default is TRUE.
  90.             Applicability is (ISGNU).
  91.  
  92.     BUGS
  93.         At the moment proportional fonts can't be handled.
  94.  
  95.     SEE ALSO
  96.         datatypesclass (where ?)
  97.  
  98.