include/SDL_clipboard.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 29 Dec 2011 13:54:22 -0500
changeset 6120 9019aa36f081
parent 6036 f2a89f2a6157
child 6138 4c64952a58fb
permissions -rw-r--r--
Fixed documentation typo
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  * \file SDL_clipboard.h
    24  *
    25  * Include file for SDL clipboard handling
    26  */
    27 
    28 #ifndef _SDL_clipboard_h
    29 #define _SDL_clipboard_h
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #include "begin_code.h"
    34 /* Set up for C function definitions, even when using C++ */
    35 #ifdef __cplusplus
    36 /* *INDENT-OFF* */
    37 extern "C" {
    38 /* *INDENT-ON* */
    39 #endif
    40 
    41 /* Function prototypes */
    42 
    43 /**
    44  * \brief Put UTF-8 text into the clipboard
    45  *
    46  * \sa SDL_GetClipboardText()
    47  */
    48 extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);
    49 
    50 /**
    51  * \brief Get UTF-8 text from the clipboard, which must be freed with SDL_free()
    52  *
    53  * \sa SDL_SetClipboardText()
    54  */
    55 extern DECLSPEC char * SDLCALL SDL_GetClipboardText(void);
    56 
    57 /**
    58  * \brief Returns a flag indicating whether the clipboard exists and contains a text string that is non-empty
    59  *
    60  * \sa SDL_GetClipboardText()
    61  */
    62 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void);
    63 
    64 
    65 /* Ends C function definitions when using C++ */
    66 #ifdef __cplusplus
    67 /* *INDENT-OFF* */
    68 }
    69 /* *INDENT-ON* */
    70 #endif
    71 #include "close_code.h"
    72 
    73 #endif /* _SDL_clipboard_h */
    74 
    75 /* vi: set ts=4 sw=4 expandtab: */