home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / Classes / Doguet / AppIconClass10 / Doc / AppIconClass.doc < prev   
Encoding:
Text File  |  1995-08-01  |  2.9 KB  |  131 lines
  1.  
  2.                File: AppIconClass.Doc
  3.         Description: AppIconClass documentation.
  4.           Copyright: (C) Copyright 1995 Doguet Emmanuel.
  5.                      All Rights Reserved.
  6.  
  7. ------------------------------------------------------------------------------
  8.  
  9. TABLE OF CONTENTS
  10.  
  11. AppIconClass/--background--
  12. AppIconClass/Methods
  13. AppIconClass/Attributes
  14.  
  15. AppIconClass/--background--                             AppIconClass/--background--
  16.  
  17.     NAME
  18.         Class:          AppIconClass
  19.         Superclass:
  20.         Include File    "AppIconClass.h"
  21.  
  22.     FUNCTION
  23.  
  24.         To provide you with a very easy way to  implement  some  AppIcon  and
  25.         AppMenuItem  in  your  programs.
  26.         The class will install for you an AppIcon or AppMenu and  return  you
  27.         the  struct  AppMessage. You can install many AppIcon and AppMenuItem
  28.         on only ONE message-port ! Only one Signal to wait for  many  AppIcon
  29.         and/or AppMenuItem.
  30.  
  31.         Is the AppIconClass.h there were too some small macro for use in the handler (see example).
  32.  
  33.         Also you program must open the following libraries:
  34.  
  35.         icon.library        - V37 or better.
  36.         workbench.library   - V37 or better
  37.         utility.library     - V37 or better.
  38.  
  39.         The source of this class is based on some  sources  of  Jan  Van  Den
  40.         Baard, the creator of the famous library: the bgui.library !!!!!
  41.  
  42.  
  43. AppIconClass/Methods                                    AppIconClass/Methods
  44.  
  45.     NEW_METHODS
  46.         GM_HANDLEINPUT  -- For receive the struct AppMessage
  47.  
  48.         OM_NEW
  49.  
  50.         OM_DISPOSE
  51.  
  52.         OM_GET
  53.  
  54.     CHANGED METHODS
  55.         None.
  56.  
  57.  
  58.  
  59.  
  60. AppIconClass/Attributes                                 AppIconClass/Attributes
  61.  
  62.     NAME
  63.         AIC_AppName -- (STRPTR)
  64.  
  65.     FUNCTION
  66.         Name of AppIcon or AppItem.
  67.  
  68.  
  69.  
  70.     NAME
  71.         AIC_ErrorCode -- (ULONG *)
  72.  
  73.     FUNCTION
  74.         Return an Error code if there were some problems
  75.  
  76.     Default is NULL -   Applicability is (S)
  77.  
  78.  
  79.  
  80.     NAME
  81.         AIC_IconFileName -- (STRPTR)
  82.  
  83.     FUNCTION
  84.         Used for get the diskobject of a icon for apply it to the AppIcon.
  85.         It must contain the name of the icon without the '.info'.
  86.         If NULL, it use the DefObject (WBTOOL).
  87.  
  88.     Default is NULL -   Applicability is (S)
  89.  
  90.  
  91.  
  92.     NAME
  93.         AIC_AppIconMask -- (ULONG *)
  94.  
  95.     FUNCTION
  96.         For get the signal mask of AppIcons/AppMenus.
  97.  
  98.         Applicability is (G)
  99.  
  100.  
  101.  
  102.     NAME
  103.         AIC_AppMenuItem -- (BOOL)
  104.  
  105.     FUNCTION
  106.         If TRUE, tell that you want an AppMenuItem instead of an AppIcon.
  107.  
  108.     Default is FALSE.   Applicability is (S)
  109.  
  110.  
  111.  
  112.     NAME
  113.         AIC_AppIconX -- (LONG)
  114.  
  115.     FUNCTION
  116.         The horizontal position of the AppIcon. (If the place is FREE).
  117.  
  118.     Default is 0.   Applicability is (S)
  119.  
  120.  
  121.  
  122.     NAME
  123.         AIC_AppIconY -- (LONG)
  124.  
  125.     FUNCTION
  126.         The vertical position of the AppIcon. (If the place is FREE).
  127.  
  128.     Default is 0.   Applicability is (S)
  129.  
  130.  
  131.