logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Clipboard Class Reference

Inheritance diagram for Gtk::Clipboard:

Inheritance graph
[legend]
List of all members.

Public Types

typedef SigC::Slot2< void,
GtkSelectionData*, guint > 
SlotGet
 e.g.: void on_get(GtkSelectionData* selection_data, guint info);

typedef SigC::Slot0<void> SlotClear
 e.g.: void on_clear();

typedef SigC::Slot1< void,
GtkSelectionData* > 
SlotReceived
 e.g.: void on_received(GtkSelectionData* selection_data);

typedef SigC::Slot1< void,
const Glib::ustring& > 
SlotTextReceived
 e.g.: void on_textreceived(const Glib::ustring& text);


Public Methods

virtual ~Clipboard ()
GtkClipboard* gobj ()
const GtkClipboard* gobj () const
GtkClipboard* gobj_copy ()
Glib::RefPtr<Gdk::Displayget_display ()
Glib::RefPtr<const Gdk::Displayget_display () const
bool set (const GtkTargetEntry* targets, guint n_targets, const SlotGet& slot_get, const SlotClear& slot_clear)
Glib::RefPtr<Glib::Objectget_owner ()
 If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner().

Glib::RefPtr<const Glib::Objectget_owner () const
 If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner().

void clear ()
 Clears the contents of the clipboard.

void set_text (const Glib::ustring& text)
void request_contents (GdkAtom target, const SlotReceived& slot)
void request_text (const SlotTextReceived& slot)
GtkSelectionData* wait_for_contents (GdkAtom target)
 Requests the contents of the clipboard using the given target.

Glib::ustring wait_for_text ()
 Requests the contents of the clipboard as text and converts the result to UTF-8 if necessary.

bool wait_is_text_available ()
 Test to see if there is text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the names: STRING, TEXT, COMPOUND_TEXT, UTF8_STRING.


Static Public Methods

Glib::RefPtr<Clipboard> create ()
Glib::RefPtr<Clipboard> get_for_display (const Glib::RefPtr<Gdk::Display>& display, GdkAtom selection)

Protected Methods

 Clipboard ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gtk::Clipboard> wrap (GtkClipboard* object, bool take_copy=false)

Member Typedef Documentation

typedef SigC::Slot0<void> Gtk::Clipboard::SlotClear
 

e.g.: void on_clear();

typedef SigC::Slot2<void, GtkSelectionData*, guint> Gtk::Clipboard::SlotGet
 

e.g.: void on_get(GtkSelectionData* selection_data, guint info);

typedef SigC::Slot1<void, GtkSelectionData*> Gtk::Clipboard::SlotReceived
 

e.g.: void on_received(GtkSelectionData* selection_data);

typedef SigC::Slot1<void, const Glib::ustring&> Gtk::Clipboard::SlotTextReceived
 

e.g.: void on_textreceived(const Glib::ustring& text);


Constructor & Destructor Documentation

virtual Gtk::Clipboard::~Clipboard (   [virtual]
 

Gtk::Clipboard::Clipboard (   [protected]
 


Member Function Documentation

void Gtk::Clipboard::clear (  
 

Clears the contents of the clipboard.

Generally this should only be called between the time you call gtk_clipboard_set_with_owner() or gtk_clipboard_set_with_data(), and when the clear_func you supplied is called. Otherwise, the clipboard may be owned by someone else.

Glib::RefPtr<Clipboard> Gtk::Clipboard::create (   [static]
 

Glib::RefPtr<const Gdk::Display> Gtk::Clipboard::get_display (   const
 

Glib::RefPtr<Gdk::Display> Gtk::Clipboard::get_display (  
 

Glib::RefPtr<Clipboard> Gtk::Clipboard::get_for_display ( const Glib::RefPtr<Gdk::Display>&    display,
GdkAtom    selection
[static]
 

Glib::RefPtr<const Glib::Object> Gtk::Clipboard::get_owner (   const
 

If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner().

Returns:
The owner of the clipboard, if any; otherwise 0.

Glib::RefPtr<Glib::Object> Gtk::Clipboard::get_owner (  
 

If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner().

Returns:
The owner of the clipboard, if any; otherwise 0.

const GtkClipboard* Gtk::Clipboard::gobj (   const [inline]
 

Reimplemented from Glib::ObjectBase.

GtkClipboard* Gtk::Clipboard::gobj (   [inline]
 

Reimplemented from Glib::ObjectBase.

GtkClipboard* Gtk::Clipboard::gobj_copy (  
 

void Gtk::Clipboard::request_contents ( GdkAtom    target,
const SlotReceived   slot
 

void Gtk::Clipboard::request_text ( const SlotTextReceived   slot
 

bool Gtk::Clipboard::set ( const GtkTargetEntry*    targets,
guint    n_targets,
const SlotGet   slot_get,
const SlotClear   slot_clear
 

void Gtk::Clipboard::set_text ( const Glib::ustring   text
 

GtkSelectionData* Gtk::Clipboard::wait_for_contents ( GdkAtom    target
 

Requests the contents of the clipboard using the given target.

This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

Parameters:
target An atom representing the form into which the clipboard owner should convert the selection.
Returns:
A newly-allocated Gtk::SelectionData object or 0 if retrieving the given target failed. If non-0, this value must be freed with gtk_selection_data_free() when you are finished with it.

Glib::ustring Gtk::Clipboard::wait_for_text (  
 

Requests the contents of the clipboard as text and converts the result to UTF-8 if necessary.

This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

Returns:
A newly-allocated UTF-8 string which must be freed with Glib::free(), or 0 if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.).

bool Gtk::Clipboard::wait_is_text_available (  
 

Test to see if there is text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the names: STRING, TEXT, COMPOUND_TEXT, UTF8_STRING.

This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

This function is a little faster than calling gtk_clipboard_wait_for_text() since it doesn't need to retrieve the actual text.

Returns:
true is there is text available, false otherwise.


Friends And Related Function Documentation

Glib::RefPtr<Gtk::Clipboard> wrap ( GtkClipboard*    object,
bool    take_copy = false
[related]
 


The documentation for this class was generated from the following file:
Generated for gtkmm by Doxygen 1.3-rc1 © 1997-2001