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