@ GNU AS assembler header file for ColourMenu
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:48:09 2012
@ Jonathan Coxhead, jonathan@doves.demon.co.uk, 5 Sept 1995

@ OSLib---efficient, type-safe, transparent, extensible,
@ register-safe API coverage of RISC OS
@ 
@ Copyright (c) 1994-2012 Jonathan Coxhead and OSLib maintainers
@ 
@ Licence:
@ 
@    OSLib is free software; you can redistribute it and/or modify
@ it under the terms of the GNU General Public License as published by
@ the Free Software Foundation; either version 1, or (at your option)
@ any later version - and this with the following clarification and
@ special exception:
@ 
@    Linking this library statically or dynamically with other modules
@ is making a combined work based on this library. Thus, the terms
@ and conditions of the GNU General Public License cover the whole
@ combination.
@ 
@    As a special exception, the copyright holders of this library
@ give you permission to link this library with independent modules
@ to produce an executable, regardless of the license terms of these
@ independent modules, and to copy and distribute the resulting
@ executable under terms of your choice, provided that you also meet,
@ for each linked independent module, the terms and conditions of the
@ license of that module. An independent module is a module which is
@ not derived from or based on this library. If you modify this
@ library, you may extend this exception to your version of the library,
@ but you are not obliged to do so. If you do not wish to do so, delete
@ this exception statement from your version.
@ 
@    OSLib is distributed in the hope that it will be useful,
@ but WITHOUT ANY WARRANTY; without even the implied warranty of
@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@ GNU General Public License for more details.
@ 
@    You should have received a copy of the GNU General Public License
@ along with this programme; if not, write to the Free Software
@ Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, USA.

#ifndef ColourMenu_Hdr
#  define ColourMenu_Hdr

#  ifndef Get_Types
#    define Get_Types
#    include "oslib/Types.Hdr"
#  endif

#  ifndef Get_OS
#    define Get_OS
#    include "oslib/OS.Hdr"
#  endif

#  ifndef Get_Toolbox
#    define Get_Toolbox
#    include "oslib/Toolbox.Hdr"
#  endif

#  ifndef Get_Menu
#    define Get_Menu
#    include "oslib/Menu.Hdr"
#  endif

@Symbols for constants
#  define Class_ColourMenu 0x82980
#  define ColourMenu_GenerateAboutToBeShown 0x1
#  define ColourMenu_GenerateDialogueCompleted 0x2
#  define ColourMenu_GenerateHasBeenHidden 0x2
#  define ColourMenu_NoneEntry 0x4
#  define ColourMenu_Transparent 0x10
#  define ColourMenu_None 0xffffffff
#  define Action_ColourMenuAboutToBeShown 0x82980
#  define Action_ColourMenuDialogueCompleted 0x82981
#  define Action_ColourMenuHasBeenHidden 0x82981
#  define Action_ColourMenuSelection 0x82982
#  define Error_ColourMenuTasksActive 0x80b000
#  define Error_ColourMenuAllocFailed 0x80b001
#  define Error_ColourMenuShortBuffer 0x80b002
#  define Error_ColourMenuNoSuchTask 0x80b011
#  define Error_ColourMenuNoSuchMethod 0x80b012
#  define Error_ColourMenuNoSuchMiscOpMethod 0x80b013

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Bits
ColourMenu_Flags               : 

        .struct 0
        .skip   Int
ColourMenu_Colour              : 

        .struct 0
ColourMenu_Object_flags        : .skip   ColourMenu_Flags
ColourMenu_Object_title        : .skip   Toolbox_MsgReference
ColourMenu_Object_title_limit  : .skip   Int
ColourMenu_Object_colour       : .skip   ColourMenu_Colour
ColourMenu_Object              : 

        .struct 0
        Toolbox_ResourceFileObject_MEMBERS ColourMenu_ObjectTemplate
ColourMenu_ObjectTemplate_objectflags: .skip   ColourMenu_Flags
ColourMenu_ObjectTemplate_title: .skip   Toolbox_MsgReference
ColourMenu_ObjectTemplate_title_limit: .skip   Int
ColourMenu_ObjectTemplate_colour: .skip   ColourMenu_Colour
ColourMenu_ObjectTemplate      : 

        .struct 0
        .skip   OS_Coord
ColourMenu_Full                : 

        .struct 0
ColourMenu_ActionAboutToBeShown_tag: .skip   Toolbox_PositionTag
ColourMenu_ActionAboutToBeShown_position: 
ColourMenu_ActionAboutToBeShown_position_top_left: .skip   OS_Coord
        .struct ColourMenu_ActionAboutToBeShown_position
ColourMenu_ActionAboutToBeShown_position_full: .skip   ColourMenu_Full
ColourMenu_ActionAboutToBeShown: 

        .struct 0
        Toolbox_ActionHeader_MEMBERS ColourMenu_ActionAboutToBeShownBlock
ColourMenu_ActionAboutToBeShownBlock_tag: .skip   Toolbox_PositionTag
ColourMenu_ActionAboutToBeShownBlock_position: 
ColourMenu_ActionAboutToBeShownBlock_position_top_left: .skip   OS_Coord
        .struct ColourMenu_ActionAboutToBeShownBlock_position
ColourMenu_ActionAboutToBeShownBlock_position_full: .skip   ColourMenu_Full
ColourMenu_ActionAboutToBeShownBlock: 

        .struct 0
        .skip   Toolbox_ActionHeaderBase
ColourMenu_ActionHasBeenHiddenBlock: 

        .struct 0
        .skip   Toolbox_ActionHeaderBase
ColourMenu_ActionDialogueCompletedBlock: 

        .struct 0
ColourMenu_ActionSelection_colour: .skip   ColourMenu_Colour
ColourMenu_ActionSelection     : 

        .struct 0
        Toolbox_ActionHeader_MEMBERS ColourMenu_ActionSelectionBlock
ColourMenu_ActionSelectionBlock_colour: .skip   ColourMenu_Colour
ColourMenu_ActionSelectionBlock: 


@Symbols for SWI's and SWI reason codes
.set XColourMenu_ClassSWI,0xa2980
.set ColourMenu_ClassSWI,0x82980

.set XColourMenu_PostFilter,0xa2981
.set ColourMenu_PostFilter,0x82981

.set XColourMenu_PreFilter,0xa2982
.set ColourMenu_PreFilter,0x82982

#  define ColourMenu_SetColour 0x0
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &0
   @  R3 = colour (ColourMenu_Colour)

#  define ColourMenu_GetColour 0x1
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &1
   @Exit
   @  R0 = colour (ColourMenu_Colour)

#  define ColourMenu_SetNoneAvailable 0x2
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &2
   @  R3 = none_available (Bool)

#  define ColourMenu_GetNoneAvailable 0x3
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &3
   @Exit
   @  R0 = none_available (Bool)

#  define ColourMenu_SetTitle 0x4
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &4
   @  R3 -> title (String)

#  define ColourMenu_GetTitle 0x5
   @Entry
   @  R0 = flags (Bits)
   @  R1 = colour_menu (Toolbox_O)
   @  R2 = &5
   @  R3 = buffer (pointer to String)
   @  R4 = size (Int)
   @Exit
   @  R4 = used (Int)

#endif
