home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / infoclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  3.7 KB  |  125 lines
  1.  
  2.                File: infoclass.doc
  3.         Description: Infoclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. infoclass/--background--
  13. infoclass/Methods
  14. infoclass/Attributes
  15.  
  16. infoclass/--background--                              infoclass/--background--
  17.  
  18.     NAME
  19.         Class:          infoclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  general  multi-line  text gadget which can be used for
  25.         on-line  help  or  general information purposes. It has the ability to
  26.         handle  different  text  style,  colors  and text justifications. Also
  27.         C-style formatting codes are allowed.
  28.  
  29.         A  good  example  of  the  usage  of this class is the BGUI_RequestA()
  30.         routine.  This  routine  uses  an infoclass object to display the body
  31.         text.
  32.  
  33.         This gadget does not send out notification events.
  34.  
  35. infoclass/Methods                                            infoclass/Methods
  36.  
  37.     NEW METHODS
  38.         None.
  39.  
  40.     CHANGED METHODS
  41.         None.
  42.  
  43. infoclass/Attributes                                      infoclass/Attributes
  44.  
  45.     NAME
  46.         INFO_TextFormat -- ( STRPTR )
  47.  
  48.     FUNCTION
  49.         Set  the  textual  contents  of the gadget object. You can use C-style
  50.         formatting  codes in the text and in addition to that you may also use
  51.         any of the following command sequences:
  52.  
  53.         \33b    - Bold text.
  54.         \33i    - Italics text.
  55.         \33u    - Underlined text.
  56.         \33n    - Normal text.
  57.         \33c    - Center this and the following lines.
  58.         \33l    - Left-justify this and the following lines.
  59.         \33r    - Right-justify this and the following lines.
  60.         \33d<n> - Set drawinfo pen <n>.
  61.         \33p<n> - Set pen <n>.
  62.         \n      - Start a new line of text.
  63.  
  64.         Please note the the \33c, \33l and \33r command sequences  can only be
  65.         used at the beginning of a new line.
  66.  
  67.         NOTE: Since  V38  of  the  library  it  is  possible  to  use locale's
  68.               FormatString()  formatting  codes.  Locale  specific  formatting
  69.               codes will only work when the locale.library is available.
  70.  
  71.         Default is NULL. Applicability is (ISU).
  72.  
  73.     SEE ALSO
  74.         <intuition/screens.h>, exec.library/RawDoFmt(), INFO_Args
  75.  
  76.     NAME
  77.         INFO_Args -- ( ULONG * )
  78.  
  79.     FUNCTION
  80.         Set  the arguments accoording to the C-style formatting codes found in
  81.         the text.
  82.  
  83.         Default is NULL. Applicability is (ISU).
  84.  
  85.     SEE ALSO
  86.         exec.library/RawDoFmt(), INFO_TextFormat
  87.  
  88.     NAME
  89.         INFO_MinLines -- ( ULONG )
  90.  
  91.     FUNCTION
  92.         Set  the  minimum  number  of  lines  the object should display at all
  93.         times.  This  is  taken into consideration when to object it's minimum
  94.         size is calculated.
  95.  
  96.         Default is 1. Applicability is (I).
  97.  
  98.     SEE ALSO
  99.         INFO_FixTextWidth
  100.  
  101.     NAME
  102.         INFO_FixTextWidth -- ( BOOL )
  103.  
  104.     FUNCTION
  105.         To tell the object that it's minimum width may not be smaller than the
  106.         width  of  the  longest  line  in the text plus the offsets and border
  107.         thickness.
  108.  
  109.         Default is FALSE. Applicability is (I).
  110.  
  111.     SEE ALSO
  112.         INFO_HorizOffset, INFO_VertOffset, INFO_MinLines
  113.  
  114.     NAME
  115.         INFO_HorizOffset, INFO_VertOffset -- ( ULONG )
  116.  
  117.     FUNCTION
  118.         Set  the  horizontal  and  vertical  offset from the object borders at
  119.         which the text is rendered.
  120.  
  121.         Defaults are 8 horizontally and 6 vertically. Applicability is (I).
  122.  
  123.     SEE ALSO
  124.         INFO_FixTextWidth
  125.