13
0
livetrax/libs/gtkmm2/gtk/gtkmm/selectiondata.h

254 lines
7.8 KiB
C
Raw Normal View History

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_SELECTIONDATA_H
#define _GTKMM_SELECTIONDATA_H
#include <glibmm.h>
/* $Id$ */
/* Copyright(C) 2002 The gtkmm Development Team
*
* This library is free software, ) you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation, ) either
* version 2 of the License, or(at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY, ) without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library, ) if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gdkmm/display.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GtkSelectionData GtkSelectionData; }
#endif
namespace Gtk
{
class SelectionData
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef SelectionData CppObjectType;
typedef GtkSelectionData BaseObjectType;
static GType get_type() G_GNUC_CONST;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
SelectionData();
explicit SelectionData(GtkSelectionData* gobject, bool make_a_copy = true);
SelectionData(const SelectionData& other);
SelectionData& operator=(const SelectionData& other);
~SelectionData();
void swap(SelectionData& other);
///Provides access to the underlying C instance.
GtkSelectionData* gobj() { return gobject_; }
///Provides access to the underlying C instance.
const GtkSelectionData* gobj() const { return gobject_; }
///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
GtkSelectionData* gobj_copy() const;
protected:
GtkSelectionData* gobject_;
private:
public:
//TODO : document this. It's like the other set(), but it uses this SelectionData's target type.
//Why would you ever want to use any other type?
void set(int format, const guint8* data, int length);
/** Assign a memory block of raw data.
* Store new data into the Gtk::SelectionData object. Should _only_ by called
* from a selection handler callback. A 0-byte terminates the stored data.
* @param type The type of the selection.
* @param format The data format, i.e. the number of bits in a unit.
* @param data Pointer to the data (will be copied).
* @param length The length of the data block in bytes.
*/
void set(const std::string& type, int format, const guint8* data, int length);
/** Assign a string of raw data.
* Store new data into the Gtk::SelectionData object. Should _only_ by called
* from a selection handler callback.
* @param type The type of the selection.
* @param data A string that contains the data (does not have to be text).
*/
void set(const std::string& type, const std::string& data);
/** Assign UTF-8 encoded text.
* Sets the contents of the selection from a UTF-8 encoded string.
* The string is converted to the form determined by get_target().
* @param data A UTF-8 encoded string.
* @return <tt>true</tt> if the selection was successfully set,
* otherwise <tt>false</tt>.
*/
bool set_text(const Glib::ustring& data);
/** Gets the contents of the selection data as a UTF-8 string.
* @return If the selection data contained a recognized text type and
* it could be converted to UTF-8, a string containing the converted text,
* otherwise an empty string.
*/
Glib::ustring get_text() const;
/** Sets the contents of the selection from a Gdk::Pixbuf
* The pixbuf is converted to the form determined by
* @a selection_data -&gt;target.
* @param pixbuf A Gdk::Pixbuf.
* @return <tt>true</tt> if the selection was successfully set,
* otherwise <tt>false</tt>.
*
* Since: 2.6.
*/
bool set_pixbuf(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf);
/** Gets the contents of the selection data as a Gdk::Pixbuf.
* @return If the selection data contained a recognized
* image type and it could be converted to a Gdk::Pixbuf, a
* newly allocated pixbuf is returned, otherwise <tt>0</tt>.
* If the result is non-<tt>0</tt> it must be freed with Glib::object_unref().
*
* Since: 2.6.
*/
Glib::RefPtr<Gdk::Pixbuf> get_pixbuf();
/** Gets the contents of the selection data as a Gdk::Pixbuf.
* @return If the selection data contained a recognized
* image type and it could be converted to a Gdk::Pixbuf, a
* newly allocated pixbuf is returned, otherwise <tt>0</tt>.
* If the result is non-<tt>0</tt> it must be freed with Glib::object_unref().
*
* Since: 2.6.
*/
Glib::RefPtr<const Gdk::Pixbuf> get_pixbuf() const;
#
/** Sets the contents of the selection from a list of URIs.
* The string is converted to the form determined by
* @a selection_data -&gt;target.
* @param uris A <tt>0</tt>-terminated array of strings hilding URIs.
* @return <tt>true</tt> if the selection was successfully set,
* otherwise <tt>false</tt>.
*
* Since: 2.6.
*/
bool set_uris(const Glib::StringArrayHandle& uris);
/** Gets the contents of the selection data as array of URIs.
* @return If the selection data contains a list of
* URIs, a newly allocated <tt>0</tt>-terminated string array
* containing the URIs, otherwise <tt>0</tt>. If the result is
* non-<tt>0</tt> it must be freed with Glib::strfreev().
*
* Since: 2.6.
*/
Glib::StringArrayHandle get_uris() const;
const guint8* get_data() const;
int get_length() const;
std::string get_data_as_string() const;
std::string get_target() const;
/// See also Gtk::Clipboard::request_targets()
Glib::StringArrayHandle get_targets() const;
/** Returns the ID of the selection.
*/
GdkAtom get_selection() const;
/** Returns the type of the data as set by SelectionData::set().
*/
std::string get_data_type() const; // get_type() already exists
int get_format() const;
Glib::RefPtr<Gdk::Display> get_display();
Glib::RefPtr<const Gdk::Display> get_display() const;
/** Given a Gtk::SelectionData object holding a list of targets,
* determines if any of the targets in @a targets can be used to
* provide text.
* @return <tt>true</tt> if @a selection_data holds a list of targets,
* and a suitable target for text is included, otherwise <tt>false</tt>.
*/
bool targets_include_text() const;
/** Given a Gtk::SelectionData object holding a list of targets,
* determines if any of the targets in @a targets can be used to
* provide a Gdk::Pixbuf.
* @param writable Whether to accept only targets for which GTK+ knows
* how to convert a pixbuf into the format.
* @return <tt>true</tt> if @a selection_data holds a list of targets,
* and a suitable target for images is included, otherwise <tt>false</tt>.
*
* Since: 2.6.
*/
bool targets_include_image(bool writable = true) const;
};
} // namespace Gtk
namespace Gtk
{
/** @relates Gtk::SelectionData
* @param lhs The left-hand side
* @param rhs The right-hand side
*/
inline void swap(SelectionData& lhs, SelectionData& rhs)
{ lhs.swap(rhs); }
} // namespace Gtk
namespace Glib
{
/** @relates Gtk::SelectionData
* @param object The C instance
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*/
Gtk::SelectionData wrap(GtkSelectionData* object, bool take_copy = false);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class Value<Gtk::SelectionData> : public Glib::Value_Boxed<Gtk::SelectionData>
{};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
} // namespace Glib
#endif /* _GTKMM_SELECTIONDATA_H */