@database ToolType.guide

@$VER: ToolType V1.00 - (C)Copyright Amiga Foundation Classes

This guide file has been created using AutoGuide V1.05 - By Fabio Rotondo (fsoft@intercom.it).

@node Main "Amiga Foundation Classes: tooltype"



                  ** ToolType - Original By Fabio Rotondo **

                       * Part of the Amiga Foundation Classes *

        @{" Introduction " link "ToolType_introduction"}             @{" Author's Info " link "author"}        @{" Amiga Foundation Classes " LINK "AFC.Guide/main"}
    
   Requires:

   Class Base: $000E0000

   NEW COMMANDS                          BRIEF DESCRIPTION
   -------------------------------------------------------------------------
   @{" tooltype()                          " link "ToolType_tooltype"} Initailizes the class.
   @{" file(programname)                   " link "ToolType_file"} Grabs an icon from a given file.
   @{" get(tooltypename)                   " link "ToolType_get"} Gets a specific ToolType from the icon.
   @{" match(tooltypename, value)          " link "ToolType_match"} Compares a ToolType with the given value.
   @{" version()                           " link "ToolType_version"} Returns tooltype version.

   @{" Error Table " LINK tooltype_ErrorTable}
@endnode

@node "ToolType_Introduction" "Introduction"

    ToolType is a class to easyly manage icons tooltypes.
    It is extremely easy to use and flexible: enjoy it!

@endnode

@node "author" "Author's Info"

    Original By:  Fabio Rotondo  (fsoft@intercom.it)

    E Version By: Fabio Rotondo

    
    
    Address:

            Fabio Rotondo
            C.so Vercelli 9
            28100 Novara
            ITALY

            e-mail: fsoft@intercom.it
                    Fabio.Rotondo@deagostini.it

            Phone:  (ITA) - (0)321 -   459676  (home)
                    (ITA) - (0)2   - 38086520  (office)
                    (ITA) - (0)338 -  7336477  (GSM Phone)

            Fax:    (ITA) - (0)2   - 38086278

            Web:    http://www.intercom.it/~fsoft               (my home page)

                    http://www.intercom.it/~fsoft/ablast.html   (Amiga Blast Home Page)

@endnode

@node tooltype_ErrorTable "ToolType / Error Table "

VALUE           | DESCRIPTION
----------------+----------------------------------------------------
$0000           | No Memory.
$0001           | Failed TO open "icon.library" (maybe wrong version)
$0002           | No valid WB Message
$0003           | File not found (the icon you are requiring does not exists)
$0004           | No Disk Icon (current program has no icon)
$0005           | Not a valid tool array structure

@endnode

@node "ToolType_tooltype" "Amiga Foundation Classes: tooltype/tooltype()"

           NAME: tooltype(grab=FALSE)

    DESCRIPTION: Use this method to initailize the object.

          INPUT: grab         - If it is TRUE, tooltype will try to get
                                tooltypes from the icon the user clicked
                                to start the program.

        RESULTS: if any error, it can raise exceptions.

       SEE ALSO:
@endnode

@node "ToolType_file" "Amiga Foundation Classes: tooltype/file()"

           NAME: file(programname:PTR TO CHAR)

    DESCRIPTION: Use this method to 'grab' tooltypes from a file.

          INPUT: file         - the name of the program you wish to
                                read ToolTypes.

        RESULTS: if any error, it can raise exceptions.

       SEE ALSO:
@endnode

@node "ToolType_get" "Amiga Foundation Classes: tooltype/get()"

           NAME: get(tooltypename:PTR TO CHAR)

    DESCRIPTION: Use this method to read the value of a specific
                 tooltype.

          INPUT: tooltypename - the name of the tooltype you want to
                                examine.

        RESULTS: a ptr to the returned value.

                 FALSE  means "ToolType" not found.

       SEE ALSO: @{" match() " LINK tooltype_match}
@endnode

@node tooltype_match "Amiga Foundation Classes: tooltype/match()"

           NAME: match(tooltypename:PTR TO CHAR, value:PTR TO CHAR)

    DESCRIPTION: Use this method to check if a particular ToolType is
                 set to a specific value.

          INPUT: tooltypename     - Name of the ToolType to examine.

                 value            - Value to match with.


        RESULTS: TRUE             - Matching successfull

                 FALSE            - Otherwise.

        EXAMPLE: match('CYBERGRAPHX', 'TRUE')

       SEE ALSO: @{" get() " LINK tooltype_get}
@endnode

@node "ToolType_version" "Amiga Foundation Classes: tooltype/version()"

           NAME: version()

    DESCRIPTION: This method returns class version and revision.

          INPUT: NONE.

        RESULTS: This method returns TWO values, Version and Revision.

       SEE ALSO:
@endnode

