SDL 3.0
|
#include <SDL3/SDL_stdinc.h>
#include <SDL3/SDL_error.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>
Go to the source code of this file.
Typedefs | |
typedef const void *(* | SDL_ClipboardDataCallback) (void *userdata, const char *mime_type, size_t *size) |
typedef void(* | SDL_ClipboardCleanupCallback) (void *userdata) |
Functions | |
bool | SDL_SetClipboardText (const char *text) |
char * | SDL_GetClipboardText (void) |
bool | SDL_HasClipboardText (void) |
bool | SDL_SetPrimarySelectionText (const char *text) |
char * | SDL_GetPrimarySelectionText (void) |
bool | SDL_HasPrimarySelectionText (void) |
bool | SDL_SetClipboardData (SDL_ClipboardDataCallback callback, SDL_ClipboardCleanupCallback cleanup, void *userdata, const char **mime_types, size_t num_mime_types) |
bool | SDL_ClearClipboardData (void) |
void * | SDL_GetClipboardData (const char *mime_type, size_t *size) |
bool | SDL_HasClipboardData (const char *mime_type) |
char ** | SDL_GetClipboardMimeTypes (size_t *num_mime_types) |
typedef void(* SDL_ClipboardCleanupCallback) (void *userdata) |
Callback function that will be called when the clipboard is cleared, or new data is set.
userdata | a pointer to provided user data. |
Definition at line 178 of file SDL_clipboard.h.
typedef const void *(* SDL_ClipboardDataCallback) (void *userdata, const char *mime_type, size_t *size) |
Callback function that will be called when data for the specified mime-type is requested by the OS.
The callback function is called with NULL as the mime_type when the clipboard is cleared or new data is set. The clipboard is automatically cleared in SDL_Quit().
userdata | a pointer to provided user data. |
mime_type | the requested mime-type. |
size | a pointer filled in with the length of the returned data. |
Definition at line 166 of file SDL_clipboard.h.
bool SDL_ClearClipboardData | ( | void | ) |
Clear the clipboard data.
\threadsafety You may only call this function from the main thread.
void * SDL_GetClipboardData | ( | const char * | mime_type, |
size_t * | size | ||
) |
Get the data from clipboard for a given mime type.
The size of text data does not include the terminator, but the text is guaranteed to be null terminated.
mime_type | the mime type to read from the clipboard. |
size | a pointer filled in with the length of the returned data. |
\threadsafety You may only call this function from the main thread.
char ** SDL_GetClipboardMimeTypes | ( | size_t * | num_mime_types | ) |
Retrieve the list of mime types available in the clipboard.
num_mime_types | a pointer filled with the number of mime types, may be NULL. |
\threadsafety You may only call this function from the main thread.
char * SDL_GetClipboardText | ( | void | ) |
Get UTF-8 text from the clipboard.
This functions returns an empty string if there was not enough memory left for a copy of the clipboard's content.
\threadsafety You may only call this function from the main thread.
char * SDL_GetPrimarySelectionText | ( | void | ) |
Get UTF-8 text from the primary selection.
This functions returns an empty string if there was not enough memory left for a copy of the primary selection's content.
\threadsafety You may only call this function from the main thread.
bool SDL_HasClipboardData | ( | const char * | mime_type | ) |
Query whether there is data in the clipboard for the provided mime type.
mime_type | the mime type to check for data for. |
\threadsafety You may only call this function from the main thread.
bool SDL_HasClipboardText | ( | void | ) |
Query whether the clipboard exists and contains a non-empty text string.
\threadsafety You may only call this function from the main thread.
bool SDL_HasPrimarySelectionText | ( | void | ) |
Query whether the primary selection exists and contains a non-empty text string.
\threadsafety You may only call this function from the main thread.
bool SDL_SetClipboardData | ( | SDL_ClipboardDataCallback | callback, |
SDL_ClipboardCleanupCallback | cleanup, | ||
void * | userdata, | ||
const char ** | mime_types, | ||
size_t | num_mime_types | ||
) |
Offer clipboard data to the OS.
Tell the operating system that the application is offering clipboard data for each of the proivded mime-types. Once another application requests the data the callback function will be called allowing it to generate and respond with the data for the requested mime-type.
The size of text data does not include any terminator, and the text does not need to be null terminated (e.g. you can directly copy a portion of a document)
callback | a function pointer to the function that provides the clipboard data. |
cleanup | a function pointer to the function that cleans up the clipboard data. |
userdata | an opaque pointer that will be forwarded to the callbacks. |
mime_types | a list of mime-types that are being offered. |
num_mime_types | the number of mime-types in the mime_types list. |
\threadsafety You may only call this function from the main thread.
bool SDL_SetClipboardText | ( | const char * | text | ) |
SDL provides access to the system clipboard, both for reading information from other processes and publishing information of its own.
This is not just text! SDL apps can access and publish data by mimetype. Put UTF-8 text into the clipboard.
text | the text to store in the clipboard. |
\threadsafety You may only call this function from the main thread.
bool SDL_SetPrimarySelectionText | ( | const char * | text | ) |
Put UTF-8 text into the primary selection.
text | the text to store in the primary selection. |
\threadsafety You may only call this function from the main thread.