pointer

/* Copyright 1996 Acorn Computers Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/****************************************************************************
 * This source file was written by Acorn Computers Limited. It is part of   *
 * the RISCOS library for writing applications in C for RISC OS. It may be  *
 * used freely in the creation of programs for Archimedes. It should be     *
 * used with Acorn's C Compiler Release 3 or later.                         *
 *                                                                          *
 ***************************************************************************/

/* Title:       pointer.h
 * Purpose:     Setting of the pointer shape
 *
 */

# ifndef __pointer_h
# define __pointer_h

# ifndef __sprite_h
# include "sprite.h"
# endif

# ifndef __os_h
# include "os.h"
# endif

# ifndef __wimp_h
# include "wimp.h"
# endif


/* -------------------------- pointer_set_shape ---------------------------
 * Description:   Sets pointer shape 2, to sprite, from sprite area
 *
 * Parameters:    sprite_area* -- area where sprite is to be found
 *                sprite_id* -- identity of the sprite
 *                int, int -- active point for pointer
 * Returns:       possible error condition.
 * Other Info:    typical use is to change pointer shape on entering/leaving
 *                application window (appropriate events are returned from
 *                wimp_poll.
 *
 */

os_error *pointer_set_shape(sprite_area *, sprite_id *, int, int) ;


/* ------------------------- pointer_reset_shape ---------------------------
 * Description:   Resets pointer shape to shape 1.
 *
 * Parameters:    void
 * Returns:       void
 * Other Info:    Typically should be called when leaving application
 *                window.
 *
 */

void pointer_reset_shape(void) ;

#endif

/* end pointer.h */