workbench/system/Wanderer/Tools/DiskInfo/diskinfo.doc

   1 TABLE OF CONTENTS
   2
   3 DiskInfo.mui/DiskInfo.mui
   4
   5     A DiskInfo object, for general using and particulary Wanderer use.
   6
   7     BACKGROUND
   8     DiskInfo provides a sub-window for disk/volumes informations
   9     like size, name, icon image, buffers, Format feature, etc.
  10     User can set different aspects and skills levels.
  11     DiskInfo requires one argument: The initial path to disk icon.
  12
  13     EXAMPLE
  14     {
  15     ...
  16         if (DiskInfo_Initialize())
  17         {
  18         ...
  19             application = DiskInfoObject,
  20                 MUIA_DiskInfo_Initial, (IPTR) initial,
  21             End;
  22
  23             if (application != NULL)
  24             {
  25                 DoMethod(application, MUIM_Application_Execute);
  26                 MUI_DisposeObject(application);
  27             }
  28         ...
  29             DiskInfo_Deinitialize();
  30         }
  31     ...
  32     }
  33
  34     FUNCTIONS
  35     DiskInfo.mui/DiskInfo_Initialize()
  36     DiskInfo.mui/DiskInfo_Deinitialize()
  37
  38     ATTRIBUTES
  39     DiskInfo.mui/MUIA_DiskInfo_Initial   [I..]
  40     DiskInfo.mui/MUIA_DiskInfo_Volname   [..G]
  41     DiskInfo.mui/MUIA_DiskInfo_Percent   [..G]
  42     DiskInfo.mui/MUIA_DiskInfo_Aspect    [ISG]
  43     DiskInfo.mui/MUIA_DiskInfo_UserLevel [..G]
  44
  45     METHODS
  46     DiskInfo.mui/MUIM_Application_Execute
  47     DiskInfo.mui/OM_NEW
  48     DiskInfo.mui/OM_GET
  49     DiskInfo.mui/OM_SET
  50     DiskInfo.mui/OM_DISPOSE
  51
  52 DiskInfo.mui/DiskInfo_Initialize()
  53
  54     NAME
  55     DiskInfo_Initialize()
  56
  57
  58 DiskInfo.mui/MUIA_DiskInfo_Initial
  59
  60     NAME
  61     MUIA_DiskInfo_Initial -- [I..], STRPTR
  62
  63     FUNCTION
  64     Provide at initialization time a path to the disk.
  65
  66     EXAMPLE
  67     Wanderer Info passes a "Volume:Disk" string.
  68     (because of its icon oriented nature, given that a volume
  69     icon is located at volume root in "Disk.info").
  70
  71     SEE ALSO
  72     DiskInfo.mui/MUIA_DiskInfo_Volname
  73
  74 DiskInfo.mui/MUIA_DiskInfo_Volname
  75
  76     NAME
  77     MUIA_DiskInfo_Volname -- [..G], STRPTR
  78
  79     FUNCTION
  80     Compute the volume name from the path given through MUIA_DiskInfo_Initial.
  81
  82     SEE ALSO
  83     DiskInfo.mui/MUIA_DiskInfo_Initial
  84
  85 DiskInfo.mui/MUIA_DiskInfo_Percent
  86
  87     NAME
  88     MUIA_DiskInfo_Percent -- [..G], ULONG
  89
  90     FUNCTION
  91     Compute the percent of disk full.
  92
  93     SEE ALSO
  94
  95 DiskInfo.mui/MUIA_DiskInfo_Aspect
  96
  97     NAME
  98     MUIA_DiskInfo_Aspect -- [ISG], ULONG
  99
 100     FUNCTION
 101     GUI Aspect, actually 2 aspects are available.
 102     More in the future.
 103
 104     SEE ALSO
 105
 106 DiskInfo.mui/MUIA_DiskInfo_UserLevel
 107
 108     NAME
 109     MUIA_DiskInfo_UserLevel -- [..G], ULONG
 110
 111     FUNCTION
 112     UserLevel follows the Installer® MINUSER level:
 113         NOVICE              -> Hidden "Format" button
 114         AVERAGE/ADVANCED    -> Ghosted "Format" button, &checkmark
 115         EXPERT              -> Active "Format" button.
 116     By default AVERAGE, but ideally read from SYS:Utilities/Installer.info icon
 117     "MINUSER" tooltype.
 118
 119     SEE ALSO