1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2024 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
36extern "C" {
37#endif
38
39/* Function prototypes */
40
41/**
42 * Put UTF-8 text into the clipboard.
43 *
44 * \param text the text to store in the clipboard
45 * \returns 0 on success or a negative error code on failure; call
46 * SDL_GetError() for more information.
47 *
48 * \since This function is available since SDL 2.0.0.
49 *
50 * \sa SDL_GetClipboardText
51 * \sa SDL_HasClipboardText
52 */
53extern DECLSPEC int SDLCALL SDL_SetClipboardText(const char *text);
54
55/**
56 * Get UTF-8 text from the clipboard, which must be freed with SDL_free().
57 *
58 * This functions returns empty string if there was not enough memory left for
59 * a copy of the clipboard's content.
60 *
61 * \returns the clipboard text on success or an empty string on failure; call
62 * SDL_GetError() for more information. Caller must call SDL_free()
63 * on the returned pointer when done with it (even if there was an
64 * error).
65 *
66 * \since This function is available since SDL 2.0.0.
67 *
68 * \sa SDL_HasClipboardText
69 * \sa SDL_SetClipboardText
70 */
71extern DECLSPEC char * SDLCALL SDL_GetClipboardText(void);
72
73/**
74 * Query whether the clipboard exists and contains a non-empty text string.
75 *
76 * \returns SDL_TRUE if the clipboard has text, or SDL_FALSE if it does not.
77 *
78 * \since This function is available since SDL 2.0.0.
79 *
80 * \sa SDL_GetClipboardText
81 * \sa SDL_SetClipboardText
82 */
83extern DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void);
84
85/**
86 * Put UTF-8 text into the primary selection.
87 *
88 * \param text the text to store in the primary selection
89 * \returns 0 on success or a negative error code on failure; call
90 * SDL_GetError() for more information.
91 *
92 * \since This function is available since SDL 2.26.0.
93 *
94 * \sa SDL_GetPrimarySelectionText
95 * \sa SDL_HasPrimarySelectionText
96 */
97extern DECLSPEC int SDLCALL SDL_SetPrimarySelectionText(const char *text);
98
99/**
100 * Get UTF-8 text from the primary selection, which must be freed with
101 * SDL_free().
102 *
103 * This functions returns empty string if there was not enough memory left for
104 * a copy of the primary selection's content.
105 *
106 * \returns the primary selection text on success or an empty string on
107 * failure; call SDL_GetError() for more information. Caller must
108 * call SDL_free() on the returned pointer when done with it (even if
109 * there was an error).
110 *
111 * \since This function is available since SDL 2.26.0.
112 *
113 * \sa SDL_HasPrimarySelectionText
114 * \sa SDL_SetPrimarySelectionText
115 */
116extern DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void);
117
118/**
119 * Query whether the primary selection exists and contains a non-empty text
120 * string.
121 *
122 * \returns SDL_TRUE if the primary selection has text, or SDL_FALSE if it
123 * does not.
124 *
125 * \since This function is available since SDL 2.26.0.
126 *
127 * \sa SDL_GetPrimarySelectionText
128 * \sa SDL_SetPrimarySelectionText
129 */
130extern DECLSPEC SDL_bool SDLCALL SDL_HasPrimarySelectionText(void);
131
132
133/* Ends C function definitions when using C++ */
134#ifdef __cplusplus
135}
136#endif
137#include "close_code.h"
138
139#endif /* SDL_clipboard_h_ */
140
141/* vi: set ts=4 sw=4 expandtab: */
142