include/SDL_clipboard.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 07 Jul 2010 23:54:03 -0700
changeset 4495 dbbfdb9ea716
parent 4494 621dc91c7a04
child 4506 b577f47379f3
permissions -rw-r--r--
Simplified clipboard API for sanity's sake.

A complete clipboard implementation would support multiple formats that could be queried at runtime, events for when the clipboard contents changed, support for HTML, images, etc. We're not going that crazy, at least for now. :)
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  * \file SDL_clipboard.h
    25  *
    26  * Include file for SDL clipboard handling
    27  */
    28 
    29 #ifndef _SDL_clipboard_h
    30 #define _SDL_clipboard_h
    31 
    32 #include "SDL_stdinc.h"
    33 
    34 #include "begin_code.h"
    35 /* Set up for C function definitions, even when using C++ */
    36 #ifdef __cplusplus
    37 /* *INDENT-OFF* */
    38 extern "C" {
    39 /* *INDENT-ON* */
    40 #endif
    41 
    42 /* Function prototypes */
    43 
    44 /**
    45  * \brief Put UTF-8 text into the clipboard
    46  *
    47  * \sa SDL_GetClipboardText()
    48  */
    49 extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);
    50 
    51 /**
    52  * \brief Get UTF-8 text from the clipboard, which must be freed with SDL_free()
    53  *
    54  * \sa SDL_SetClipboardText()
    55  */
    56 extern DECLSPEC char * SDLCALL SDL_GetClipboardText();
    57 
    58 /**
    59  * \brief Returns whether the clipboard has text
    60  *
    61  * \sa SDL_GetClipboardText()
    62  */
    63 extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText();
    64 
    65 
    66 /* Ends C function definitions when using C++ */
    67 #ifdef __cplusplus
    68 /* *INDENT-OFF* */
    69 }
    70 /* *INDENT-ON* */
    71 #endif
    72 #include "close_code.h"
    73 
    74 #endif /* _SDL_clipboard_h */
    75 
    76 /* vi: set ts=4 sw=4 expandtab: */