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,
SelectionData&, guint > 
SlotGet
 e.g.: void on_get(Gtk::SelectionData& selection_data, guint info);

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

typedef SigC::Slot1< void,
const SelectionData& > 
SlotReceived
 e.g.: void on_received(const SelectionData& selection_data);

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


Public Member Functions

virtual ~Clipboard ()
GtkClipboard* gobj ()
 Provides access to the underlying C GObject.

const GtkClipboard* gobj () const
 Provides access to the underlying C GObject.

GtkClipboard* gobj_copy ()
Glib::RefPtr<Gdk::Displayget_display ()
Glib::RefPtr<const Gdk::Displayget_display () const
bool set (const ArrayHandle_TargetEntry& targets, const SlotGet& slot_get, const SlotClear& slot_clear)
 Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested.

Glib::RefPtr<Glib::Objectget_owner ()
Glib::RefPtr<const Glib::Objectget_owner () const
void clear ()
 Clears the contents of the clipboard.

void set_text (const Glib::ustring& text)
 Sets the contents of the clipboard to the given UTF-8 string.

void request_contents (const Glib::ustring& target, const SlotReceived& slot)
void request_targets (const SlotReceived& slot)
void request_text (const SlotTextReceived& slot)
SelectionData wait_for_contents (const Glib::ustring& target) const
 Requests the contents of the clipboard using the given target.

Glib::ustring wait_for_text () const
bool wait_is_text_available () const

Static Public Member Functions

Glib::RefPtr<Clipboardget (GdkAtom selection=GDK_SELECTION_CLIPBOARD)
Glib::RefPtr<Clipboardget_for_display (const Glib::RefPtr<Gdk::Display>& display, GdkAtom selection=GDK_SELECTION_CLIPBOARD)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gtk::Clipboardwrap (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, SelectionData&, guint> Gtk::Clipboard::SlotGet
 

e.g.: void on_get(Gtk::SelectionData& selection_data, guint info);

typedef SigC::Slot1<void, const SelectionData&> Gtk::Clipboard::SlotReceived
 

e.g.: void on_received(const SelectionData& 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]
 


Member Function Documentation

void Gtk::Clipboard::clear (  ) 
 

Clears the contents of the clipboard.

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

Glib::RefPtr<Clipboard> Gtk::Clipboard::get ( GdkAtom  selection = GDK_SELECTION_CLIPBOARD  )  [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 = GDK_SELECTION_CLIPBOARD
[static]
 

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

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

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

GtkClipboard* Gtk::Clipboard::gobj_copy (  ) 
 

void Gtk::Clipboard::request_contents ( const Glib::ustring&  target,
const SlotReceived slot
 

void Gtk::Clipboard::request_targets ( const SlotReceived slot  ) 
 

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

bool Gtk::Clipboard::set ( const ArrayHandle_TargetEntry targets,
const SlotGet slot_get,
const SlotClear slot_clear
 

Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested.

Parameters:
targets Information about the available forms for the clipboard data.
slot_get method to call to get the actual clipboard data.
slot_clear When the clipboard contents are set again, this method will be called, and slot_get will not be subsequently called.
Returns:
true if setting the clipboard data succeeded. If setting the clipboard data failed then the provided callback methods will be ignored.

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

Sets the contents of the clipboard to the given UTF-8 string.

GTK+ will make a copy of the text and take responsibility for responding for requests for the text, and for converting the text into the requested format.

Parameters:
text A UTF-8 string.

SelectionData Gtk::Clipboard::wait_for_contents ( const Glib::ustring&  target  )  const
 

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 The form into which the clipboard owner should convert the selection.
Returns:
A SelectionData object, which will be invalid if retrieving the given target failed.

Glib::ustring Gtk::Clipboard::wait_for_text (  )  const
 

bool Gtk::Clipboard::wait_is_text_available (  )  const
 


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 gtkmm2.2 by Doxygen 1.3.3 © 1997-2001