home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / pascal / library / dos / tvision / gravis / gv / gvmenus.doc < prev    next >
Encoding:
Text File  |  1994-05-23  |  3.5 KB  |  93 lines

  1. Documentation of GVMenus
  2. ========================
  3.  
  4. GVMenus is a Turbo Pascal unit and is part of the Graphics Vision
  5. package.
  6. GVMenus provides the pulldown menus and the statusline of GV.
  7.  
  8. Methods that are not mentioned are compatible with TV.
  9.  
  10. Menus
  11. -----
  12.  
  13. dfXXXXX: flags for the field Disabled of a Tmenuitem record.
  14.          The single flags have the following meaning:
  15.  
  16.          dfDisabled: The menu options is inactive if this flag is enabled.
  17.                      This is the same as if in TV the field Disabled was true.
  18.  
  19.          dfMenuCheck: Close to the text of a menu option the hook known
  20.                       from Windows will be drawn is this flag is enabled.
  21.                       The options reacts like an item of a Tcheckboxes
  22.                       object.
  23.  
  24.          dfRadio: If this flag is enabled in addition to dfMenuCheck all
  25.                   menu options (submenus will not be considered) this flag
  26.                   is enabled in react like items of n Tradiobuttons object,
  27.                   i.e. the hook mentioned above will only be drawn close to
  28.                   one menu option.
  29.  
  30.          dfCheckState: If enabled the hook is visible else not.
  31.  
  32.          dfBitmap: If this flag is enabled the field Name of the menu option
  33.                    will be interpreted as a pointer at a bitmap, which was
  34.                    created with VGAMem.GetImage (see there) else as a pointer
  35.                    on a String as usual.
  36.  
  37. Because of these functionality enlargements of the menu there are two other
  38. Tmenuitem routines than the ones known from TV.
  39.  
  40. function NewBitmap(Bitmap: Pointer; KeyCode: Word; Command: Word;
  41.   AHelpCtx: Word; Next: PMenuItem): PMenuItem;
  42.  
  43.   creates a menuoptions which draws a bitmap instead of a text.
  44.   Bitmap is a pointer on a bitmap created with VGAMem.GetImage.
  45.   Besides this the function is compatible with NewItem.
  46.   Hint: Please note, that NewBitmap makes its own copy of the bitmap
  47.         data in memory. So you have to deallocate the bitmap given in
  48.         the parameter yourself.
  49.  
  50. function NewBmpSubMenu(Bitmap: Pointer; AHelpCtx: Word; SubMenu: PMenu;
  51.   Next: PMenuItem): PMenuItem;
  52.  
  53.   creates a submenu which draws a bitmap instead of a text.
  54.   Bitmap is a pointer on a bitmap created with VGAMem.GetImage.
  55.   Besides this the function is compatible with NewSubMenu.
  56.   Hint: Please note, that NewBitmap makes its own copy of the bitmap
  57.         data in memory. So you have to deallocate the bitmap given in
  58.         the parameter yourself.
  59.  
  60. Tmenuitem
  61. ---------
  62.  
  63. Name: To use texts and bitmaps in menus Name is an untypified pointer.
  64.  
  65. Disabled: has beside the duty of declaring a menu option inactive some
  66.           other duties (see dfXXXXX).
  67.  
  68. Tmenuview
  69. ---------
  70.  
  71. procedure drawitem (item: Pmenuitem); virtual;
  72.  
  73.   draws the menuitem item is pointing at on the screen. Drawitem should
  74.   not be called by GV users.
  75.   In Tmenuview drawitem is an abstract method. Only Tmenuviews's
  76.   descendants give any function to drawitem.
  77.  
  78. Hint: Menu options that do not contain a submenu shouldn't be used
  79.       with Tmenubar objects.
  80.  
  81. Tstatusline
  82. -----------
  83.  
  84. In GV it is possible to give certains chars to control the output font
  85. of a statusitem or statushint. The first char of the text stands for
  86. the used font:
  87.  
  88.   #0 - ftSystem is used for the following text
  89.   #1 - ftSansSerif is used for the following text
  90.   #2 - ftMonoSpace is used for the following text
  91.  
  92. If another char is used GV uses automatically ftSystem.
  93. (also see ExtGraph - ftXXXXX)