@database Icons.guide
@remark ENGLISH VERSION
@author Eddie Churchill
@(c) "Copyright © 1993 Inovatronics, Inc."
@$VER: Icons.guide 2.5 (06/01/93)
@wordwrap
@font topaz.font 8
@index "CanDo_LexiconIndex"

@node "CanDo_Icons_Index" "Icons Commands, Functions and Variables"
@toc "CanDo_LexiconMain"
@{fg highlight}Available Topics...@{fg text}

  Command  @{" ClipIconImage                  " link "CanDo_ClipIconImage"}
  Function @{" =DefaultTool()                 " link "CanDo_DefaultTool"}
  Function @{" =IconHighlight()               " link "CanDo_IconHighlight"}
  Function @{" =IconType()                    " link "CanDo_IconType"}
  Command  @{" InsertToolTypeList             " link "CanDo_InsertToolTypeList"}
  Command  @{" LoadIcon                       " link "CanDo_LoadIcon"}
  Command  @{" MakeIcon                       " link "CanDo_MakeIcon"}
  Command  @{" SaveIcon                       " link "CanDo_SaveIcon"}
  Command  @{" SetDefaultTool                 " link "CanDo_SetDefaultTool"}
  Command  @{" SetIconHighlight               " link "CanDo_SetIconHighlight"}
  Command  @{" SetIconImage                   " link "CanDo_SetIconImage"}
  Command  @{" SetToolTypeList                " link "CanDo_SetToolTypeList"}
@endnode

@node "CanDo_clipiconimage" "ClipIconImage {IconBufferName}, {BrushBufferName} [,{AltBrushBufferName}]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  ClipIconImage {IconBufferName}, {BrushBufferName} [,{AltBrushBufferName}]

@{fg highlight}Description...@{fg text}

  Extracts the image or images used in an icon, storing them as brushes so
you can show them or save them within your application.
  
  SEE ALSO: @{" SetIconImage " link "CanDo_SetIconImage"}.

@endnode

@node "CanDo_defaulttool" "Let {FilePath}=DefaultTool({IconBufferName})"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  Let {FilePath}=DefaultTool({IconBufferName})

@{fg highlight}Description...@{fg text}

  Returns the default tool of "Icon Name".  This is the program to be run
if a user double-clicks on the icon from the Workbench.
  
  SEE ALSO: @{" SetDefaultTool " link "CanDo_SetDefaultTool"}.

@endnode

@node "CanDo_iconhighlight" "Let {String}=IconHighlight({IconBufferName})"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=IconHighlight({IconBufferName})

@{fg highlight}Description...@{fg text}

  Returns the highlight style used by the icon, either "COMPLEMENT",
"BACKFILL", or "ALTIMAGE".
  
  SEE ALSO: @{" SetIconHighlight " link "CanDo_SetIconHighlight"}.

@endnode

@node "CanDo_icontype" "Let {String}=IconType({IconBufferName})"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  Let {String}=IconType({IconBufferName})

@{fg highlight}Description...@{fg text}

  Returns the icontype which can be one of the following:

   "Project", "Disk", "Drawer", "Tool",
   "NDOS", "Device", "KickStart", or
   "Unknown"

@endnode

@node "CanDo_inserttooltypelist" "InsertToolTypeList {IconBufferName}"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  InsertToolTypeList {IconBufferName}

@{fg highlight}Description...@{fg text}

  Types the ToolTypes of the icon into the current document.
  
  SEE ALSO: @{" SetToolTypeList " link "CanDo_SetToolTypeList"}.

@endnode

@node "CanDo_loadicon" "LoadIcon {FilePath} [,{IconBufferName} [,<loadflags>]]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  LoadIcon {FilePath} [,{IconBufferName} [,<loadflags>]]

@{fg highlight}Description...@{fg text}

  Loads an icon into a buffer.
  
  SEE ALSO: @{" SaveIcon " link "CanDo_SaveIcon"} and @{" MakeIcon " link "CanDo_MakeIcon"}.

@endnode

@node "CanDo_makeicon" "MakeIcon {IconBufferName}, <flags>, {BrushBufferName} [,{AltBrushBufferName}]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  MakeIcon {IconBufferName}, <flags>, {BrushBufferName} [,{AltBrushBufferName}]

@{fg highlight}Description...@{fg text}

  Creates an Icon buffer.
  
  SEE ALSO: @{" SaveIcon " link "CanDo_SaveIcon"} and @{" LoadIcon " link "CanDo_LoadIcon"}.

@endnode

@node "CanDo_saveicon" "SaveIcon {IconBufferName} [,{SaveFilePath}]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  SaveIcon {IconBufferName} [,{SaveFilePath}]

@{fg highlight}Description...@{fg text}

  Saves an Icon buffer.
  
  SEE ALSO: @{" MakeIcon " link "CanDo_MakeIcon"} and @{" LoadIcon " link "CanDo_LoadIcon"}.

@endnode

@node "CanDo_setdefaulttool" "SetDefaultTool {IconBufferName}, {ToolString}"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  SetDefaultTool {IconBufferName}, {ToolString}

@{fg highlight}Description...@{fg text}

  Sets the Default tool used by the given Icon.  The default tool is the
program to be run if a user double-clicks on the icon from the Workbench.
  
  SEE ALSO: @{" TheDefaultTool " link "CanDo_TheDefaultTool"}.

@endnode

@node "CanDo_seticonhighlight" "SetIconHighlight {IconBufferName}, <flags> [,{AltBrushBufferName}]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  SetIconHighlight {IconBufferName}, <flags> [,{AltBrushBufferName}]

@{fg highlight}Description...@{fg text}

  This changes the highlight style of the icon buffer.
  
  SEE ALSO: @{" IconHighlight " link "CanDo_IconHighlight"}.

@endnode

@node "CanDo_seticonimage" "SetIconImage {IconBufferName}, {BrushBufferName} [,{AltBrushBufferName}]"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  SetIconImage {IconBufferName}, {BrushBufferName} [,{AltBrushBufferName}]

@{fg highlight}Description...@{fg text}

  This command sets the icon's image and, optionally, its alternate image.
  
  SEE ALSO: @{" ClipIconImage " link "CanDo_ClipIconImage"}.

@endnode

@node "CanDo_settooltypelist" "SetToolTypeList {IconBufferName}, {DocumentBufferName}"
@toc "CanDo_Icons_Index"
@{fg highlight}Command...@{fg text}

  SetToolTypeList {IconBufferName}, {DocumentBufferName}

@{fg highlight}Description...@{fg text}

  This commands sets the tooltype list of the given icon buffer to the
contents of the given document buffer.
  
  SEE ALSO: @{" InsertToolTypeList " link "CanDo_InsertToolTypeList"}.

@endnode