[gtkmm] Gdk, Gtk: Update for the latest gtk4 (update some class descriptions)
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Gdk, Gtk: Update for the latest gtk4 (update some class descriptions)
- Date: Thu, 3 Dec 2020 14:51:36 +0000 (UTC)
commit fd16c7d892c85e3eb07d6c14915b2e61549cc368
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Thu Dec 3 15:38:58 2020 +0100
Gdk, Gtk: Update for the latest gtk4 (update some class descriptions)
and remove Gtk::TextBuffer::property_[copy,paste]_target_list()
gdk/src/devicetool.hg | 4 ++--
gdk/src/gltexture.hg | 3 +--
gdk/src/memorytexture.hg | 3 +--
gdk/src/snapshot.hg | 2 +-
gtk/src/filechooser.hg | 48 +++++++++++++++++++++++++++++++-----------------
gtk/src/textbuffer.hg | 2 --
6 files changed, 36 insertions(+), 26 deletions(-)
---
diff --git a/gdk/src/devicetool.hg b/gdk/src/devicetool.hg
index 282a979a..3b51d45a 100644
--- a/gdk/src/devicetool.hg
+++ b/gdk/src/devicetool.hg
@@ -24,8 +24,8 @@ _CC_INCLUDE(gdk/gdk.h)
namespace Gdk
{
-//TODO: Add class documentation when GdkDeviceTool is documented.
-/**
+/** A physical tool associated to a Gdk::Device.
+ *
* @newin{3,94}
*/
class GDKMM_API DeviceTool : public Glib::Object
diff --git a/gdk/src/gltexture.hg b/gdk/src/gltexture.hg
index 2e382a6c..0964baad 100644
--- a/gdk/src/gltexture.hg
+++ b/gdk/src/gltexture.hg
@@ -23,8 +23,7 @@ namespace Gdk
{
class GDKMM_API GLContext;
-//TODO: When GdkGLTexture gets a class description, copy it.
-/** Pixel data.
+/** A Gdk::Texture representing a GL texture object.
*
* @newin{3,94}
*/
diff --git a/gdk/src/memorytexture.hg b/gdk/src/memorytexture.hg
index c3d4184c..2a0e930d 100644
--- a/gdk/src/memorytexture.hg
+++ b/gdk/src/memorytexture.hg
@@ -23,8 +23,7 @@ _PINCLUDE(gdkmm/private/texture_p.h)
namespace Gdk
{
-//TODO: When GdkMemoryTexture gets a class description, copy it.
-/** Pixel data.
+/** A Gdk::Texture representing image data in memory.
*
* @newin{3,98}
*/
diff --git a/gdk/src/snapshot.hg b/gdk/src/snapshot.hg
index 30e561f0..e4ca180b 100644
--- a/gdk/src/snapshot.hg
+++ b/gdk/src/snapshot.hg
@@ -24,7 +24,7 @@ _PINCLUDE(glibmm/private/object_p.h)
namespace Gdk
{
-/** Auxiliary object for snapshots.
+/** Base type for snapshot operations.
*
* @see Gtk::Snapshot
*
diff --git a/gtk/src/filechooser.hg b/gtk/src/filechooser.hg
index 0d1505cd..ad9dcca1 100644
--- a/gtk/src/filechooser.hg
+++ b/gtk/src/filechooser.hg
@@ -35,28 +35,42 @@ namespace Gtk
*/
_WRAP_GERROR(FileChooserError,GtkFileChooserError,GTK_FILE_CHOOSER_ERROR, decl_prefix GTKMM_API)
-/**
- * Gtk::FileChooser is an interface that can be implemented by file selection
+/** File chooser interface used by %Gtk::FileChooserWidget and %Gtk::FileChooserDialog.
+ *
+ * %Gtk::FileChooser is an interface that can be implemented by file selection
* widgets. In gtkmm, the main objects that implement this interface are
* FileChooserWidget and FileChooserDialog. You do not need to write an
- * object that implements the FileChooser interface unless you are trying to
+ * object that implements the %FileChooser interface unless you are trying to
* adapt an existing file selector to expose a standard programming interface.
*
- * @par File Names and Encodings
- * When the user is finished selecting files in a FileChooser, your program
- * can get the selected names either as filenames or as URIs. For URIs, the
- * normal escaping rules are applied if the URI contains non-ASCII characters.
- * However, filenames are always returned in the character set specified by the
- * G_FILENAME_ENCODING environment variable. Please see the Glib documentation
- * for more details about this variable.
+ * %Gtk::FileChooser allows for shortcuts to various places in the filesystem.
+ * In the default implementation these are displayed in the left pane. It
+ * may be a bit confusing at first that these shortcuts come from various
+ * sources and in various flavours, so lets explain the terminology here:
+ *
+ * - Bookmarks: are created by the user, by dragging folders from the
+ * right pane to the left pane, or by using the “Add”. Bookmarks
+ * can be renamed and deleted by the user.
+ *
+ * - Shortcuts: can be provided by the application. For example, a Paint
+ * program may want to add a shortcut for a Clipart folder. Shortcuts
+ * cannot be modified by the user.
+ *
+ * - Volumes: are provided by the underlying filesystem abstraction. They are
+ * the “roots” of the filesystem.
+ *
+ * @par File Names
+ * When the user is finished selecting files in a %Gtk::FileChooser,
+ * your program can get the selected filenames as Gio::File objects.
*
- * @par Important
- * This means that while you can pass the result of FileChooser::get_filename()
- * to <tt>open(2)</tt> or <tt>fopen(3)</tt>, you may not be able to directly
- * set it as the text of a Gtk::Label widget unless you convert it first to
- * UTF-8, which all gtkmm widgets expect. You should use
- * Glib::filename_to_utf8() to convert filenames into strings that can be
- * passed to gtkmm widgets.
+ * @par Adding Options
+ * You can add extra widgets to a file chooser to provide options
+ * that are not present in the default design, by using
+ * add_choice(). Each choice has an identifier and
+ * a user visible label; additionally, each choice can have multiple
+ * options. If a choice has no option, it will be rendered as a
+ * check button with the given label; if a choice has options, it will
+ * be rendered as a combo box.
*/
class GTKMM_API FileChooser : public Glib::Interface
{
diff --git a/gtk/src/textbuffer.hg b/gtk/src/textbuffer.hg
index 8d6cef9c..bb5c3393 100644
--- a/gtk/src/textbuffer.hg
+++ b/gtk/src/textbuffer.hg
@@ -550,8 +550,6 @@ _CONVERSION(`GtkTextIter*',`TextBuffer::iterator&',Glib::wrap_iter($3))
_WRAP_PROPERTY("text", Glib::ustring)
_WRAP_PROPERTY("has-selection", bool)
_WRAP_PROPERTY("cursor-position", int)
- _WRAP_PROPERTY("copy-target-list", Glib::RefPtr<Gdk::ContentFormats>)
- _WRAP_PROPERTY("paste-target-list", Glib::RefPtr<Gdk::ContentFormats>)
_WRAP_PROPERTY("can-undo", bool)
_WRAP_PROPERTY("can-redo", bool)
_WRAP_PROPERTY("enable-undo", bool)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]