px4-firmware/nuttx/graphics/nxsu/nxfe.h

186 lines
6.6 KiB
C
Raw Normal View History

/****************************************************************************
* graphics/nxsu/nxfe.h
*
* Copyright (C) 2008-2010 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __GRAPHICS_NXSU_NXFE_H
#define __GRAPHICS_NXSU_NXFE_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <mqueue.h>
#include <semaphore.h>
#include <nuttx/nx/nx.h>
#include "nxbe.h"
/****************************************************************************
* Pre-Processor Definitions
****************************************************************************/
/****************************************************************************
* Public Types
****************************************************************************/
/* Server state structure ***************************************************/
/* This the server 'front-end' state structure. It is really the same
* as the back-end state, but we wrap the back-end state so that we can add
* things to the structure in the future
*/
struct nxfe_state_s
{
/* The 'back-end' window status. Must be first so that instances of
* struct nxbe_state_s can be simply cast to an instance of struct
* nxfe_state_s
*/
struct nxbe_state_s be;
};
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
EXTERN const struct nx_callback_s g_bkgdcb;
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nxfe_constructwindow
*
* Description:
* This function is the same a nx_openwindow EXCEPT that the client provides
* the window structure instance. nx_constructwindow will initialize the
* the pre-allocated window structure for use by NX. This function is
* provided in addition to nx_open window in order to support a kind of
* inheritance: The caller's window structure may include extensions that
* are not visible to NX.
*
* NOTE: wnd must have been allocated using malloc() (or related allocators)
* Once provided to nxfe_constructwindow() that memory is owned and managed
* by NX. On certain error conditions or when the window is closed, NX will
* free() the window.
*
* Input Parameters:
* handle - The handle returned by nx_connect
* wnd - The pre-allocated window structure.
* cb - Callbacks used to process window events
* arg - User provided value that will be returned with NX callbacks.
*
* Return:
* OK on success; ERROR on failure with errno set appropriately. In the
* case of ERROR, NX will have dealloated the pre-allocated window.
*
****************************************************************************/
EXTERN int nxfe_constructwindow(NXHANDLE handle,
FAR struct nxbe_window_s *wnd,
FAR const struct nx_callback_s *cb,
FAR void *arg);
/****************************************************************************
* Name: nxfe_redrawreq
*
* Descripton:
* Request the client that has this window to redraw the rectangular region.
*
****************************************************************************/
EXTERN void nxfe_redrawreq(FAR struct nxbe_window_s *wnd,
FAR const struct nxgl_rect_s *rect);
/****************************************************************************
* Name: nxfe_reportposition
*
* Descripton:
* Report the new size/position of the window.
*
****************************************************************************/
EXTERN void nxfe_reportposition(FAR struct nxbe_window_s *wnd);
/****************************************************************************
* Name: nxmu_mouseinit
*
* Description:
* Initialize with the mouse in the center of the display
*
****************************************************************************/
#ifdef CONFIG_NX_MOUSE
EXTERN void nxsu_mouseinit(int x, int y);
#endif
/****************************************************************************
* Name: nxmu_mousereport
*
* Description:
* Report mouse position info to the specified window
*
* Input Parameters:
* wnd - The window to receive the mouse report
*
* Returned Value:
* 0: Mouse report sent; >0: Mouse report not sent; <0: An error occurred
*
****************************************************************************/
#ifdef CONFIG_NX_MOUSE
EXTERN int nxsu_mousereport(struct nxbe_window_s *wnd);
#endif
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __GRAPHICS_NXSU_NXFE_H */