/*

     SDL - Simple DirectMedia Layer

     Copyright (C) 1997-2010 Sam Lantinga

     This library is free software; you can redistribute it and/or

     modify it under the terms of the GNU Lesser General Public

     License as published by the Free Software Foundation; either

     version 2.1 of the License, or (at your option) any later version.

     This library 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

     Lesser General Public License for more details.

     You should have received a copy of the GNU Lesser General Public

     License along with this library; if not, write to the Free Software

     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

     Sam Lantinga

     slouken@libsdl.org

 */

 /**

  * \file SDL_clipboard.h

  *

  * Include file for SDL clipboard handling

  */

 #ifndef _SDL_clipboard_h

 #define _SDL_clipboard_h

 #include "SDL_stdinc.h"

 #include "SDL_surface.h"

 #include "begin_code.h"

 /* Set up for C function definitions, even when using C++ */

 #ifdef __cplusplus

 /* *INDENT-OFF* */

 extern "C" {

 /* *INDENT-ON* */

 #endif

 /* Function prototypes */

 /**

  * \brief Put text into the clipboard

  *

  * \sa SDL_GetClipboardText()

  */

 extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);

 /**

  * \brief Get text from the clipboard, which must be freed with SDL_free()

  *

  * \sa SDL_SetClipboardText()

  */

 extern DECLSPEC char * SDLCALL SDL_GetClipboardText();

 /**

  * \brief Returns whether the clipboard has text

  *

  * \sa SDL_GetClipboardText()

  */

 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText();

 /**

  * \brief Put an image into the clipboard

  *

  * \sa SDL_GetClipboardImage()

  */

 extern DECLSPEC int SDLCALL SDL_SetClipboardImage(SDL_Surface *image);

 /**

  * \brief Get image from the clipboard, which must be freed with SDL_FreeSurface()

  *

  * \sa SDL_SetClipboard()

  */

 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetClipboardImage();

 /**

  * \brief Returns whether the clipboard has data in the specified format

  *

  * \sa SDL_GetClipboardImage()

  */

 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardImage();

 /**

  * \brief Set the data in the clipboard in the specified format

  *

  * \sa SDL_GetClipboard()

  */

 extern DECLSPEC int SDLCALL SDL_SetClipboard(Uint32 format, void *data, size_t length);

 /**

  * \brief Get the data in the clipboard in the specified format, which must be

  *        freed with SDL_free()

  *

  * \sa SDL_SetClipboard()

  */

 extern DECLSPEC int SDLCALL SDL_GetClipboard(Uint32 format, void **data, size_t *length);

 /**

  * \brief Returns whether the clipboard has data in the specified format

  *

  * \sa SDL_GetClipboard()

  */

 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardFormat(Uint32 format);

 /**

  * \brief Clear any data out of the clipboard, if possible.

  */

 extern DECLSPEC void SDLCALL SDL_ClearClipboard(void);

 /* Ends C function definitions when using C++ */

 #ifdef __cplusplus

 /* *INDENT-OFF* */

 }

 /* *INDENT-ON* */

 #endif

 #include "close_code.h"

 #endif /* _SDL_clipboard_h */

 /* vi: set ts=4 sw=4 expandtab: */