SDL_clipboard.h

00001 /*
00002   Simple DirectMedia Layer
00003   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
00004 
00005   This software is provided 'as-is', without any express or implied
00006   warranty.  In no event will the authors be held liable for any damages
00007   arising from the use of this software.
00008 
00009   Permission is granted to anyone to use this software for any purpose,
00010   including commercial applications, and to alter it and redistribute it
00011   freely, subject to the following restrictions:
00012 
00013   1. The origin of this software must not be misrepresented; you must not
00014      claim that you wrote the original software. If you use this software
00015      in a product, an acknowledgment in the product documentation would be
00016      appreciated but is not required.
00017   2. Altered source versions must be plainly marked as such, and must not be
00018      misrepresented as being the original software.
00019   3. This notice may not be removed or altered from any source distribution.
00020 */
00021 
00022 /**
00023  * \file SDL_clipboard.h
00024  *
00025  * Include file for SDL clipboard handling
00026  */
00027 
00028 #ifndef _SDL_clipboard_h
00029 #define _SDL_clipboard_h
00030 
00031 #include "SDL_stdinc.h"
00032 
00033 #include "begin_code.h"
00034 /* Set up for C function definitions, even when using C++ */
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00039 /* Function prototypes */
00040 
00041 /**
00042  * \brief Put UTF-8 text into the clipboard
00043  *
00044  * \sa SDL_GetClipboardText()
00045  */
00046 extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);
00047 
00048 /**
00049  * \brief Get UTF-8 text from the clipboard, which must be freed with SDL_free()
00050  *
00051  * \sa SDL_SetClipboardText()
00052  */
00053 extern DECLSPEC char * SDLCALL SDL_GetClipboardText(void);
00054 
00055 /**
00056  * \brief Returns a flag indicating whether the clipboard exists and contains a text string that is non-empty
00057  *
00058  * \sa SDL_GetClipboardText()
00059  */
00060 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void);
00061 
00062 
00063 /* Ends C function definitions when using C++ */
00064 #ifdef __cplusplus
00065 }
00066 #endif
00067 #include "close_code.h"
00068 
00069 #endif /* _SDL_clipboard_h */
00070 
00071 /* vi: set ts=4 sw=4 expandtab: */