TABLE OF CONTENTS

cl_mui.library/--macro-instances--
cl_mui.library/CLMUI_Boards2lv
cl_mui.library/CLMUI_CheckmarkExcludeA
cl_mui.library/CLMUI_Copy_lv_Active
cl_mui.library/CLMUI_DisableA
cl_mui.library/CLMUI_ErrorRequest
cl_mui.library/CLMUI_FindDel
cl_mui.library/CLMUI_FindIn_lv
cl_mui.library/CLMUI_Gruppen2lv
cl_mui.library/CLMUI_HelpFileName
cl_mui.library/CLMUI_Info
cl_mui.library/CLMUI_Links2lv
cl_mui.library/CLMUI_lv2Gruppen
cl_mui.library/CLMUI_lv2Verteiler
cl_mui.library/CLMUI_NewObjectA
cl_mui.library/CLMUI_SetCycleChain
cl_mui.library/CLMUI_str2lv
cl_mui.library/CLMUI_TickDelay
cl_mui.library/CLMUI_Verteiler2lv
cl_mui.library/CLMUI_WildcardSelect
cl_mui.library/--macro-instances--         cl_mui.library/--macro-instances--

                       
   FUNCTION

   cl_mui.library (V3) contains several function instances of
   actual MUI macros which should help to reduce code size.
   You can get redefinitions of the standard macros by adding

   #define _CLMUI_MACROFUNCS
   #include <cl/cl_mui.h>

   before including any mui headers.

   Macros include:

      String()
      KeyString()
      CheckMark()
      KeyCheckMark()
      SimpleButton()
      KeyButton()
      Cycle()
      KeyCycle()
      Radio()
      KeyRadio()
      Slider()
      KeySlider()
      PopButton()
      xLabelx()


cl_mui.library/CLMUI_Boards2lv                 cl_mui.library/CLMUI_Boards2lv

   NAME
   CLMUI_Boards2lv -- load Connectline board-list into the given MUI
                      listview-gadget.

   SYNOPSIS
   CLMUI_Boards2lv( lv, Autoeintrag )
                   A0        D1

   void CLMUI_Boards2lv( APTR, BOOL );

   FUNCTION
   Load  Connectline board-list into given listview

   INPUTS
   lv -- MUI listview-object
   Autoeintrag -- TRUE if only boards with "Autoeintrag von ..." should 
                  be displayed

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_CheckmarkExcludeA cl_mui.library/CLMUI_CheckmarkExcludeA

   NAME
   CLMUI_CheckmarkExcludeA -- Creates Checkmarks which exclude themselves

   SYNOPSIS
   CLMUI_CheckmarkExcludeA( checkmark, ... )
                   A0        D1

   void CLMUI_CheckmarkExcludeA( APTR, ... );

   FUNCTION
   Sets Methods in a way, that only one of the given checkmarks can be
   checked at the same time. If one gets check, every other one gets
   unselected

   INPUTS
   checkmark -- MUI checkmark-object

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_Copy_lv_Active       cl_mui.library/CLMUI_Copy_lv_Active

   NAME
   CLMUI_FindIn_lv -- Copies active entry from one listview to another


   SYNOPSIS
   CLMUI_( lv_src, lv_dest )
             A0      A1

   CLMUI_Copy_lv_Active( APTR, APTR );

   FUNCTION
   Copies active entry of the source listview and copies it to the other one.
   If it is already present there, it won't be inserted a second time.

   INPUTS
   lv_src -- MUI listview-gadget source
   lv_dest -- MUI listview-gedget destination

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_DisableA                   cl_mui.library/CLMUI_DisableA

   NAME
   CLMUI_DisableA -- Enable/Disable List Of Objects (V10)
                       
   SYNOPSIS
   CLMUI_DisableA( state, objlist )
                    D0      A0
                        
   void CLMUI_DisableA( LONG, APTR * );
   void CLMUI_Disable( LONG, ..., NULL );


   FUNCTION
   Sets MUIA_Disabled, state on all objects.

   INPUTS
   state -- TRUE or FALSE
   objlist -- NULL terminated list of objects

   RESULT
   None.

   EXAMPLE

   NOTES

   BUGS
   Will crash if objlist contains more than 128 objects.

   SEE ALSO

cl_mui.library/CLMUI_ErrorRequest           cl_mui.library/CLMUI_ErrorRequest

   NAME
   CLMUI_ErrorRequest -- check error and display requester.
                       
   SYNOPSIS
   errorcode = CLMUI_ErrorRequest()
   D0                      

   LONG CLMUI_ErrorRequest( void );

   FUNCTION
   Perform MUI_Error() and, upon a non-null return, display
   an appropriate error requester.

   INPUTS
   None.

   RESULT
   errorcode -- as returned from MUI_Error(). The requester
                is only displayed if the return value is
                none-null.

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_FindDel                     cl_mui.library/CLMUI_FindDel

   NAME
   CLMUI_FindDel -- Deletes an entry of a listview given by its name

   SYNOPSIS
   CLMUI_FindDel( lv, searchstring )
                   A0      A1

   CLMUI_FindIn_lv( APTR, char * );

   FUNCTION
   Delete an entry of a listview given by its name

   INPUTS
   lv -- MUI listview-gadget
   searchstring -- name of entry to delete

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_FindIn_lv                 cl_mui.library/CLMUI_FindIn_lv

   NAME
   CLMUI_FindIn_lv -- Looks for an entry in a listview of strings and
                      returns ist position.


   SYNOPSIS
   position = CLMUI_FindInlv( lv, searchstring )
                   A0      A1

   long CLMUI_FindIn_lv( APTR, char * );

   FUNCTION
   Find entry in Listview and return its position

   INPUTS
   lv -- MUI listview-gadget
   searchstring -- String to search for

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_Gruppen2lv               cl_mui.library/CLMUI_Gruppen2lv

   NAME
   CLMUI_Gruppen2lv -- Display COnnectline group flag-set in a MUI 
                       listview-gadget


   SYNOPSIS
   CLMUI_Gruppen2lv( groups, lv )
                     A0      A1

   void CLMUI_Gruppen2lv( char *, APTR );

   FUNCTION
   Displays all group-names an selects flags set.

   INPUTS
   groups -- flag-set for groups
   lv -- MUI listview-gadget

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO
   lv2Gruppen()

cl_mui.library/CLMUI_HelpFileName           cl_mui.library/CLMUI_HelpFileName

   NAME
   CLMUI_HelpFileName -- return name of application help file (V8)
                       
   SYNOPSIS
   CLMUI_HelpFileNameA( appname, to )
                          A0     A1
                         
   void CLMUI_HelpFileName( STRPTR, STRPTR );

   FUNCTION
   Returns the complete path name of the application help file.
   Correctly handles locale et al settings.

   INPUTS
   appname -- name of your application
   to -- where to write the name to. Must be at least 128 chars.

   RESULT
   None.

   EXAMPLE

    UBYTE helpfile[ 128 ];
    CLMUI_HelpFileName( "CL-Port-Prefs", helpfile );

    ApplicationObject,
        MUIA_Application_HelpFile, helpfile,

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_Info                           cl_mui.library/CLMUI_Info

   NAME
   CLMUI_Info -- display Info requester (v4)

   SYNOPSIS
   CLMUI_Info( applicationobject )
                      A0         

   void CLMUI_Info( APTR );

   FUNCTION
   Display standard Connectline MUI-Info requester.

   INPUTS
   applicationobject -- pointer to a MUI application object.
                        This will serve as a source of information
                        for the information text to display.

   RESULT
   None.

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_Links2lv                   cl_mui.library/CLMUI_Links2lv

   NAME
   CLMUI_Links2lv -- load Connectline system-list into the given MUI
                      listview-gadget.

   SYNOPSIS
   CLMUI_Links2lv( lv )
                    A0

   void CLMUI_Boards2lv( APTR );

   FUNCTION
   Load Connectline system-list into given listview

   INPUTS
   lv -- MUI listview-object

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_lv2Gruppen               cl_mui.library/CLMUI_lv2Gruppen

   NAME
   CLMUI_lv2Gruppen -- Copy contents of am MUI Listview to a group-set


   SYNOPSIS
   CLMUI_lv2Gruppen( lv, groups, mode)
                     A0    A1     D0

   void CLMUI_Boards2lv( APTR, char *, ULONG );

   FUNCTION
   Copies listviews contents to a flag set.

   INPUTS
   lv -- MUI listview-object
   groups -- flag-set to be written to
   mode -- One of the following:

       CLMUI_MODE_OVERWRITE: All flags will be cleared an every entry selecte
d
                             in the listview will be set.
       CLMUI_MODE_ADD:       Selected entries will be set in the flag-set
       CLMUI_MODE_DEL:       Selected entries will be cleared in the flag-set


   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO
   CLMUI_Gruppen2lv()

cl_mui.library/CLMUI_lv2Verteiler           cl_mui.library/CLMUI_lv2Verteiler

   NAME
   CLMUI_lv2Verteiler -- Copy contents of am MUI Listview to an entry
                         in the board-list as a "Verteiler"

   SYNOPSIS
   CLMUI_lv2Verteiler( lv, board, mode)
                       A0   A1     D0

   void CLMUI_Verteiler2lv( APTR, struct Brett *, ULONG );

   FUNCTION
   Copies listviews contents to a board as a "Verteiler"

   INPUTS
   lv -- MUI listview-object
   board -- valid entry in the board list, to be written to
   mode -- One of the following:

       CLMUI_MODE_OVERWRITE: All entries will be cleared an every entry
                             in the listview will be copied.
       CLMUI_MODE_ADD:       All entries will be added.
       CLMUI_MODE_DEL:       All entries will be deleted.


   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO
   CLMUI_Verteiler2lv()

cl_mui.library/CLMUI_NewObjectA               cl_mui.library/CLMUI_NewObjectA

   NAME
   CLMUI_NewObjectA -- find Connectline specific MUI class and
                       perform a new object on it (V1)
   CLMUI_NewObject -- varargs version

   SYNOPSIS
   object = CLMUI_NewObjectA( classname, taglist )
   D0                         A0         A1

   APTR CLMUI_NewObjectA( STRPTR, APTR );
   APTR CLMUI_NewObject( STRPTR, ... );

   FUNCTION
   Finds a Connectline specific MUI class and performs a
   NewObject on it with the given tag parameters. 

   INPUTS
   classname -- name of class you wish to create an instance of.
   taglist -- passed down to NewObject().

   RESULT
   object -- Pointer to your newly created class instance or NULL
             upon error.

   EXAMPLE

   NOTES
   You must *not* close "cl_mui.library" before disposing
   all objects created with CLMUI_NewObject(), otherweise
   the class libraries might get expunged while in use...

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_SetCycleChain         cl_mui.library/CLMUI_SetCycleChain

   NAME
   CLMUI_SetCycleChainA -- set cycle chain of window object (V7)
   CLMUI_SetCycleChain -- varargs version (V7)
                       
   SYNOPSIS
   CLMUI_SetCycleChainA( windowobj, objects )
                            A0         A1
   CLMUI_SetCycleChain( windowobj, obj1, ... )
                         
   void CLMUI_SetCycleChainA( APTR, APTR * );
   void CLMUI_SetCycleChain( APTR, ... );

   FUNCTION
   Performs DoMethodA( windowobj, MUIM_Window_SetCycleChain, objects ),
   but handles object list differently: NULL items are skipped
   silently and the list is ended with CLMUI_SCCEND (-1). This allows
   for dynamically build cycle chains.

   INPUTS
   windowobj -- MUI window object
   objects -- List of objects (not TagItems!)

   RESULT
   None.

   EXAMPLE

       CLMUI_SetCycleChain( mainwin,
          gadget1,
          gadget2,
          gadget3,
          gadget4
          CLMUI_SCCEND
      );

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_str2lv                       cl_mui.library/CLMUI_str2lv

   NAME
   CLMUI_str2lv -- Copies a string into a listview


   SYNOPSIS
   CLMUI_str2lv( lv, string )
           A0    A1

   CLMUI_str2lv( APTR, char * );

   FUNCTION
   Copies the string into the listview.
   If it is already present there, it won't be inserted a second time.

   INPUTS
   lv -- MUI listview-gadget
   str -- String to copy

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_TickDelay                 cl_mui.library/CLMUI_TickDelay

   NAME
   CLMUI_TickDelay -- Delay() with MUIM_InputBuffered (V9)
                       
   SYNOPSIS
   CLMUI_TickDelay( appobj, ticks )
                      A0      D0
                        
   void CLMUI_TickDelay( APTR, LONG );

   FUNCTION
   Same as dos.library/Delay(), but constantly does
   MUIM_Application_InputBuffered every ~10 ticks.
   Correctly measures delay due to the input handler
   and bases it's timing on this.

   INPUTS
   appobj -- your application object
   ticks -- number of ticks to delay

   RESULT
   None.

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO

cl_mui.library/CLMUI_Verteiler2lv           cl_mui.library/CLMUI_Verteiler2lv

   NAME
   CLMUI_Verteiler2lv -- Display Connectline board "Verteiler" in a MUI
                       listview-gadget.


   SYNOPSIS
   CLMUI_Verteiler2lv( board, lv )
                     A0      A1

   void CLMUI_Verteiler2lv( struct Brett *, APTR );

   FUNCTION
   Adds all entries in the "Verteiler" to the listview.

   INPUTS
   board -- board to read from
   lv -- MUI listview-gadget

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO
   lv2Verteiler()

cl_mui.library/CLMUI_WildcardSelect       cl_mui.library/CLMUI_WildcardSelect

   NAME
   CLMUI_WildcardsSelect -- Selects entries in a multiselect-listview


   SYNOPSIS
   CLMUI_WildcardSelect( lv, wildcard, state )
                         A0      A1      D0

   CLMUI_str2lv( APTR, char *, LONG);

   FUNCTION
   Sets those entries in the listview, which match the wildcard, to
   the given state (TRUE or FALSE);

   INPUTS
   lv -- MUI multiselect listview-gadget
   wildcard -- wildcard pattern
   state -- state to set matching entries to

   EXAMPLE

   NOTES

   BUGS
   None known.

   SEE ALSO