NbtkClipboard

NbtkClipboard — a simple representation of the X clipboard

Synopsis

                    NbtkClipboard;
void                (*NbtkClipboardCallbackFunc)        (NbtkClipboard *clipboard,
                                                         const gchar *text,
                                                         gpointer user_data);
NbtkClipboard*      nbtk_clipboard_get_default          ();
void                nbtk_clipboard_get_text             (NbtkClipboard *clipboard,
                                                         NbtkClipboardCallbackFunc callback,
                                                         gpointer user_data);
void                nbtk_clipboard_set_text             (NbtkClipboard *clipboard,
                                                         const gchar *text);

Object Hierarchy

  GObject
   +----NbtkClipboard

Description

NbtkCliboard is a very simple object representation of the clipboard available to applications. Text is always assumed to be UTF-8 and non-text items are not handled.

Details

NbtkClipboard

typedef struct _NbtkClipboard NbtkClipboard;

The contents of this structure is private and should only be accessed using the provided API.


NbtkClipboardCallbackFunc ()

void                (*NbtkClipboardCallbackFunc)        (NbtkClipboard *clipboard,
                                                         const gchar *text,
                                                         gpointer user_data);

Callback function called when text is retrieved from the clipboard.

clipboard :

A NbtkClipboard

text :

text from the clipboard

user_data :

user data

nbtk_clipboard_get_default ()

NbtkClipboard*      nbtk_clipboard_get_default          ();

Get the global NbtkClipboard object that represents the clipboard.

Returns :

a NbtkClipboard owned by Nbtk and must not be unrefferenced or freed.

nbtk_clipboard_get_text ()

void                nbtk_clipboard_get_text             (NbtkClipboard *clipboard,
                                                         NbtkClipboardCallbackFunc callback,
                                                         gpointer user_data);

Request the data from the clipboard in text form. callback is executed when the data is retreived.

clipboard :

A NbtkCliboard

callback :

function to be called when the text is retreived

user_data :

data to be passed to the callback

nbtk_clipboard_set_text ()

void                nbtk_clipboard_set_text             (NbtkClipboard *clipboard,
                                                         const gchar *text);

Sets text as the current contents of the clipboard.

clipboard :

A NbtkClipboard

text :

text to copy to the clipboard