SDL 3.0
SDL_clipboard.h File Reference
+ Include dependency graph for SDL_clipboard.h:
+ This graph shows which files directly or indirectly include this file:

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)
 

Detailed Description

Include file for SDL clipboard handling

Definition in file SDL_clipboard.h.

Typedef Documentation

◆ SDL_ClipboardCleanupCallback

typedef void(* SDL_ClipboardCleanupCallback) (void *userdata)

Callback function that will be called when the clipboard is cleared, or new data is set.

Parameters
userdataA pointer to provided user data
Since
This function is available since SDL 3.0.0.
See also
SDL_SetClipboardData

Definition at line 164 of file SDL_clipboard.h.

◆ SDL_ClipboardDataCallback

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().

Parameters
userdataA pointer to provided user data
mime_typeThe requested mime-type
sizeA pointer filled in with the length of the returned data
Returns
a pointer to the data for the provided mime-type. Returning NULL or setting length to 0 will cause no data to be sent to the "receiver". It is up to the receiver to handle this. Essentially returning no data is more or less undefined behavior and may cause breakage in receiving applications. The returned data will not be freed so it needs to be retained and dealt with internally.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetClipboardData

Definition at line 153 of file SDL_clipboard.h.

Function Documentation

◆ SDL_ClearClipboardData()

int SDL_ClearClipboardData ( void  )
extern

Clear the clipboard data

Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetClipboardData

◆ SDL_GetClipboardData()

void * SDL_GetClipboardData ( const char *  mime_type,
size_t *  size 
)
extern

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.

Parameters
mime_typeThe mime type to read from the clipboard
sizeA pointer filled in with the length of the returned data
Returns
the retrieved data buffer or NULL on failure; call SDL_GetError() for more information. Caller must call SDL_free() on the returned pointer when done with it.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetClipboardData

◆ SDL_GetClipboardText()

char * SDL_GetClipboardText ( void  )
extern

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.

Returns
the clipboard text on success or an empty string on failure; call SDL_GetError() for more information. Caller must call SDL_free() on the returned pointer when done with it (even if there was an error).
Since
This function is available since SDL 3.0.0.
See also
SDL_HasClipboardText
SDL_SetClipboardText

◆ SDL_GetPrimarySelectionText()

char * SDL_GetPrimarySelectionText ( void  )
extern

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.

Returns
the primary selection text on success or an empty string on failure; call SDL_GetError() for more information. Caller must call SDL_free() on the returned pointer when done with it (even if there was an error).
Since
This function is available since SDL 3.0.0.
See also
SDL_HasPrimarySelectionText
SDL_SetPrimarySelectionText

◆ SDL_HasClipboardData()

SDL_bool SDL_HasClipboardData ( const char *  mime_type)
extern

Query whether there is data in the clipboard for the provided mime type

Parameters
mime_typeThe mime type to check for data for
Returns
SDL_TRUE if there exists data in clipboard for the provided mime type, SDL_FALSE if it does not.
Since
This function is available since SDL 3.0.0.
See also
SDL_SetClipboardData
SDL_GetClipboardData

◆ SDL_HasClipboardText()

SDL_bool SDL_HasClipboardText ( void  )
extern

Query whether the clipboard exists and contains a non-empty text string.

Returns
SDL_TRUE if the clipboard has text, or SDL_FALSE if it does not.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetClipboardText
SDL_SetClipboardText

◆ SDL_HasPrimarySelectionText()

SDL_bool SDL_HasPrimarySelectionText ( void  )
extern

Query whether the primary selection exists and contains a non-empty text string.

Returns
SDL_TRUE if the primary selection has text, or SDL_FALSE if it does not.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetPrimarySelectionText
SDL_SetPrimarySelectionText

◆ SDL_SetClipboardData()

int SDL_SetClipboardData ( SDL_ClipboardDataCallback  callback,
SDL_ClipboardCleanupCallback  cleanup,
void *  userdata,
const char **  mime_types,
size_t  num_mime_types 
)
extern

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)

Parameters
callbackA function pointer to the function that provides the clipboard data
cleanupA function pointer to the function that cleans up the clipboard data
userdataAn opaque pointer that will be forwarded to the callbacks
mime_typesA list of mime-types that are being offered
num_mime_typesThe number of mime-types in the mime_types list
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_ClipboardDataCallback
SDL_SetClipboardData
SDL_GetClipboardData
SDL_HasClipboardData

◆ SDL_SetClipboardText()

int SDL_SetClipboardText ( const char *  text)
extern

Put UTF-8 text into the clipboard.

Parameters
textthe text to store in the clipboard
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetClipboardText
SDL_HasClipboardText

◆ SDL_SetPrimarySelectionText()

int SDL_SetPrimarySelectionText ( const char *  text)
extern

Put UTF-8 text into the primary selection.

Parameters
textthe text to store in the primary selection
Returns
0 on success or a negative error code on failure; call SDL_GetError() for more information.
Since
This function is available since SDL 3.0.0.
See also
SDL_GetPrimarySelectionText
SDL_HasPrimarySelectionText