home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_image.doc < prev    next >
Text File  |  1997-03-10  |  4KB  |  153 lines
  1. TABLE OF CONTENTS
  2.  
  3. Image.mui/Image.mui
  4. Image.mui/MUIA_Image_FontMatch
  5. Image.mui/MUIA_Image_FontMatchHeight
  6. Image.mui/MUIA_Image_FontMatchWidth
  7. Image.mui/MUIA_Image_FreeHoriz
  8. Image.mui/MUIA_Image_FreeVert
  9. Image.mui/MUIA_Image_OldImage
  10. Image.mui/MUIA_Image_Spec
  11. Image.mui/MUIA_Image_State
  12. Image.mui/Image.mui
  13.  
  14.     Image class is used to display one of MUI's standard
  15.     images or some selfmade image data.
  16. Image.mui/MUIA_Image_FontMatch
  17.  
  18.     NAME
  19.     MUIA_Image_FontMatch -- (V4 ) [I..], BOOL
  20.  
  21.     FUNCTION
  22.     If TRUE, width and height of the given image will be 
  23.     scaled to match the current font. Images are always 
  24.     defined with a reference font of topaz/8, bigger fonts 
  25.     will make the image grow (as long as its maximum size
  26.     is big enough).
  27.  
  28.     EXAMPLE
  29.     The arrows of a scroll bar are e.g. defined with
  30.     MUIA_Image_FontMatch.
  31.  
  32.     SEE ALSO
  33.     MUIA_Image_FontMatch, MUIA_Image_FontMatchWidth
  34. Image.mui/MUIA_Image_FontMatchHeight
  35.  
  36.     NAME
  37.     MUIA_Image_FontMatchHeight -- (V4 ) [I..], BOOL
  38.  
  39.     FUNCTION
  40.     If TRUE, the height of the given image will be scaled
  41.     to match the current font. Images are always defined
  42.     with a reference font of topaz/8, bigger fonts will
  43.     make the image grow (as long as its maximum size
  44.     is big enough).
  45.  
  46.     SEE ALSO
  47.     MUIA_Image_FontMatch, MUIA_Image_FontMatchWidth
  48. Image.mui/MUIA_Image_FontMatchWidth
  49.  
  50.     NAME
  51.     MUIA_Image_FontMatchWidth -- (V4 ) [I..], BOOL
  52.  
  53.     FUNCTION
  54.     If TRUE, the width of the given image will be scaled
  55.     to match the current font. Images are always defined
  56.     with a reference font of topaz/8, bigger fonts will
  57.     make the image grow (as long as its maximum size
  58.     is big enough).
  59.  
  60.     SEE ALSO
  61.     MUIA_Image_FontMatch, MUIA_Image_FontMatchHeight
  62. Image.mui/MUIA_Image_FreeHoriz
  63.  
  64.     NAME
  65.     MUIA_Image_FreeHoriz -- (V4 ) [I..], BOOL
  66.  
  67.     FUNCTION
  68.     Tell the image if its allowed to get scaled horizontally.
  69.     Defaults to FALSE.
  70.  
  71.     SEE ALSO
  72.     MUIA_Image_FreeVert, MUIA_Image_FontMatch
  73. Image.mui/MUIA_Image_FreeVert
  74.  
  75.     NAME
  76.     MUIA_Image_FreeVert -- (V4 ) [I..], BOOL
  77.  
  78.     FUNCTION
  79.     Tell the image if its allowed to get scaled vertically.
  80.     Defaults to FALSE.
  81.  
  82.     SEE ALSO
  83.     MUIA_Image_FreeHoriz, MUIA_Image_FontMatch
  84. Image.mui/MUIA_Image_OldImage
  85.  
  86.     NAME
  87.     MUIA_Image_OldImage -- (V4 ) [I..], struct Image *
  88.  
  89.     FUNCTION
  90.     Allows you to use any conventional image structure
  91.     within a MUI window. The resulting object is always
  92.     as big as the image and not resizable.
  93. Image.mui/MUIA_Image_Spec
  94.  
  95.     NAME
  96.     MUIA_Image_Spec -- (V4 ) [I..], char *
  97.  
  98.     FUNCTION
  99.     Specify the type of your image. Usually, you will
  100.     use one of the predefined standard images here,
  101.     (one of the MUII_xxx definitions from mui.h),
  102.     but you also can supply a string containing
  103.         a MUI image specification. Image specifications
  104.     always starts with a digit, followed by a ':', 
  105.     followed by some parameters. Currently, the
  106.     following things are defined (all numeric
  107.     parameters need to be ascii values!):
  108.  
  109.     "0:<x>" where <x> is between MUII_BACKGROUND and
  110.             MUII_FILLBACK2 identifying a builtin pattern.
  111.  
  112.     "1:<x>" where <x> identifies a builtin standard image.
  113.             Don't use this, use "6:<x>" instead.
  114.  
  115.     "2:<r>,<g>,<b>" where <r>, <g> and <b> are 32-bit RGB
  116.                     color values specified as 8-digit hex
  117.                     string (e.g. 00000000 or ffffffff).
  118.                     Kick 2.x users will get an empty image.
  119.  
  120.     "3:<n>" where <n> is the name of an external boopsi
  121.             image class.
  122.  
  123.     "4:<n>" where <n> is the name of an external MUI brush.
  124.  
  125.     "5:<n>" where <n> is the name of an external picture
  126.             file that should be loaded with datatypes.
  127.             Kick 2.x users will get an empty image.
  128.  
  129.     "6:<x>" where <x> is between MUII_WindowBack and
  130.             MUII_Count-1 identifying a preconfigured
  131.             image/background.
  132.  
  133.     SEE ALSO
  134.     MUIA_Image_OldImage
  135. Image.mui/MUIA_Image_State
  136.  
  137.     NAME
  138.     MUIA_Image_State -- (V4 ) [IS.], LONG
  139.  
  140.     FUNCTION
  141.     Some MUI images offer different states, you can select
  142.     one of the by setting this attribute. Simply use
  143.     one of the IDS_NORMAL, IDS_SELECTED, ... values
  144.     defined in "intuition/imageclass.h".
  145.  
  146.     Note: Objects that respond to user input will
  147.           automatically toggle their state between
  148.           IDS_NORMAL to IDS_SELECTED depending on
  149.           their MUIA_Selected attribute.
  150.  
  151.     SEE ALSO
  152.     MUIA_Image_Spec
  153.