/*
    ####             #    #     # #
    #   #            #    #       #          The FreeWare C library for
    #   #  ##   ###  #  # #     # ###             RISC OS machines
    #   # #  # #     # #  #     # #  #   ___________________________________
    #   # ####  ###  ##   #     # #  #
    #   # #        # # #  #     # #  #    Please refer to the accompanying
    ####   ### ####  #  # ##### # ###    documentation for conditions of use
    ________________________________________________________________________

    File:    Pointer.h
    Author:  Copyright  1994 Lee Atkinson
    Version: 1.00 (28 Sep 1994)
    Purpose: high level pointer handling routines
*/

#ifndef __dl_pointer_h
#define __dl_pointer_h

#ifdef __cplusplus
extern "C" {
#endif


#include "Core.h"
#include "Icon.h"
#include "Window.h"


extern os_error *Pointer_RestrictToWindow(window_handle window);
/*
  Purpose:  - Restricts pointer to window
  Inputs:   - window - handle of window which is restricted to
  Returns:  - pointer to os_error
*/


extern os_error *Pointer_RestrictToIcon(window_handle window,icon_handle icon);
/*
  Purpose:  - Restricts pointer to icon
  Inputs:   - window - handle of window which icon belongs to
              icon   - handle of icon which is restricted to
  Returns:  - pointer to os_error
*/


extern os_error *Pointer_RestrictToRect(wimp_rect rect);
/*
  Purpose:  - Restricts pointer to rectangle
  Inputs:   - rect - rectangle definition
  Returns:  - pointer to os_error
*/


extern os_error *Pointer_Unrestrict(void);
/*
  Purpose:  - Unrestricts pointer
  Returns:  - pointer to os_error
*/

#ifdef __cplusplus
}
#endif


#endif
