SDL 3.0
|
Include file for SDL clipboard handling. More...
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 | |
int | SDL_SetClipboardText (const char *text) |
char * | SDL_GetClipboardText (void) |
SDL_bool | SDL_HasClipboardText (void) |
int | SDL_SetPrimarySelectionText (const char *text) |
char * | SDL_GetPrimarySelectionText (void) |
SDL_bool | SDL_HasPrimarySelectionText (void) |
int | SDL_SetClipboardData (SDL_ClipboardDataCallback callback, SDL_ClipboardCleanupCallback cleanup, void *userdata, const char **mime_types, size_t num_mime_types) |
int | SDL_ClearClipboardData (void) |
void * | SDL_GetClipboardData (const char *mime_type, size_t *size) |
SDL_bool | SDL_HasClipboardData (const char *mime_type) |
Include file for SDL clipboard handling.
Definition in file SDL_clipboard.h.
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 164 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 153 of file SDL_clipboard.h.
int SDL_ClearClipboardData | ( | void | ) |
Clear the clipboard data
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 |
char * SDL_GetClipboardText | ( | void | ) |
Get UTF-8 text from the clipboard, which must be freed with SDL_free().
This functions returns empty string if there was not enough memory left for a copy of the clipboard's content.
char * SDL_GetPrimarySelectionText | ( | void | ) |
Get UTF-8 text from the primary selection, which must be freed with SDL_free().
This functions returns empty string if there was not enough memory left for a copy of the primary selection's content.
SDL_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 |
SDL_bool SDL_HasClipboardText | ( | void | ) |
Query whether the clipboard exists and contains a non-empty text string.
SDL_bool SDL_HasPrimarySelectionText | ( | void | ) |
Query whether the primary selection exists and contains a non-empty text string.
int 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 |
int SDL_SetClipboardText | ( | const char * | text | ) |
Put UTF-8 text into the clipboard.
text | the text to store in the clipboard |
int SDL_SetPrimarySelectionText | ( | const char * | text | ) |
Put UTF-8 text into the primary selection.
text | the text to store in the primary selection |