GNOME.org
 

[gtkmm] Docs: Update names of enumerators when _WRAP_ENUM generates enum class

commit 536459146905b70ecec942a1e00c49fb05f10c76
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Thu Jun 1 18:44:30 2017 +0200

    Docs: Update names of enumerators when _WRAP_ENUM generates enum class
    
    Fix hand-written documentation.

 gdk/src/device.hg        |   12 ++++++------
 gtk/gtkmm/accelkey.h     |    3 +--
 gtk/src/accelgroup.hg    |    8 ++++----
 gtk/src/adjustment.hg    |    2 +-
 gtk/src/button.hg        |    2 +-
 gtk/src/enums.hg         |    2 +-
 gtk/src/gesture.hg       |   18 +++++++++---------
 gtk/src/grid.hg          |    2 +-
 gtk/src/levelbar.hg      |    2 +-
 gtk/src/overlay.hg       |    6 +++---
 gtk/src/paned.hg         |    2 +-
 gtk/src/sizegroup.hg     |    4 ++--
 gtk/src/treeiter.hg      |    2 +-
 gtk/src/treeselection.hg |    8 ++++----
 14 files changed, 36 insertions(+), 37 deletions(-)
---
diff --git a/gdk/src/device.hg b/gdk/src/device.hg
index bd20249..b6882b3 100644
--- a/gdk/src/device.hg
+++ b/gdk/src/device.hg
@@ -111,7 +111,7 @@ public:
 
   /** Gets the current location of the device.
    * As a slave device coordinates are those of its master pointer,
-   * this function may not be called on devices of type GDK_DEVICE_TYPE_SLAVE,
+   * this function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @param x This will contain the root window X coordinate of the device.
@@ -121,7 +121,7 @@ public:
 
   /** Gets the current location of device.
    * As a slave device coordinates are those of its master pointer,
-   * this function may not be called on devices of type GDK_DEVICE_TYPE_SLAVE,
+   * this function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @param screen This will contain the screen that the device is on.
@@ -134,7 +134,7 @@ public:
 
   /** Gets the current location of the device in double precision.
    * As a slave device coordinates are those of its master pointer,
-   * this function may not be called on devices of type GDK_DEVICE_TYPE_SLAVE,
+   * this function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @param x This will contain the root window X coordinate of the device.
@@ -146,7 +146,7 @@ public:
 
    /** Gets the current location of the device in double precision.
    * As a slave device coordinates are those of its master pointer,
-   * this function may not be called on devices of type GDK_DEVICE_TYPE_SLAVE,
+   * this function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @param screen This will contain the screen that the device is on.
@@ -169,7 +169,7 @@ public:
    * Returns an empty RefPtr if the window tree under the device is not known to GDK (for example, belongs 
to another application).
    *
    * As a slave device coordinates are those of its master pointer, This
-   * function may not be called on devices of type Gdk::DEVICE_TYPE_SLAVE,
+   * function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @newin{3,0}
@@ -182,7 +182,7 @@ public:
    * Returns an empty RefPtr if the window tree under the device is not known to GDK (for example, belongs 
to another application).
    *
    * As a slave device coordinates are those of its master pointer, This
-   * function may not be called on devices of type Gdk::DEVICE_TYPE_SLAVE,
+   * function may not be called on devices of type Gdk::Device::Type::SLAVE,
    * unless there is an ongoing grab on them. See grab().
    *
    * @newin{3,0}
diff --git a/gtk/gtkmm/accelkey.h b/gtk/gtkmm/accelkey.h
index 0bfa518..42c19a3 100644
--- a/gtk/gtkmm/accelkey.h
+++ b/gtk/gtkmm/accelkey.h
@@ -1,4 +1,3 @@
-/* $Id$ */
 #ifndef _GTKMM_ACCELKEY_H
 #define _GTKMM_ACCELKEY_H
 
@@ -45,7 +44,7 @@ public:
 
  /** AccelKey constructor.
   * @param accel_key For instance, 'q'
-  * @param accel_mods For instance, Gdk::CONTROL_MASK
+  * @param accel_mods For instance, Gdk::ModifierType::CONTROL_MASK
   * @param accel_path For instance, "<MainWindow>/File/Open"
   */
   AccelKey(guint accel_key, Gdk::ModifierType accel_mods,
diff --git a/gtk/src/accelgroup.hg b/gtk/src/accelgroup.hg
index 5adda71..2b3256a 100644
--- a/gtk/src/accelgroup.hg
+++ b/gtk/src/accelgroup.hg
@@ -64,7 +64,7 @@ public:
 
   /** Determines whether a given keyval and modifier mask constitute
   * a valid keyboard accelerator. For example, the 'a' keyval
-  * plus Gdk::CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
+  * plus Gdk::ModifierType::CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
   * But you can't, for instance, use the GDK_Control_L keyval
   * as an accelerator.
   */
@@ -79,15 +79,15 @@ public:
 
   /** Converts an accelerator keyval and modifier mask
    * into a string parseable by parse().
-   * For example, if you pass in 'q' and Gdk::CONTROL_MASK, it returns "&lt;Control&gt;q".
+   * For example, if you pass in 'q' and Gdk::ModifierType::CONTROL_MASK, it returns "&lt;Control&gt;q".
    */
   static Glib::ustring name(guint accelerator_key, Gdk::ModifierType accelerator_mods);
 
   _WRAP_METHOD(static Glib::ustring get_label(guint accelerator_key, Gdk::ModifierType accelerator_mods), 
gtk_accelerator_get_label)
 
   /** Sets the modifiers that will be considered significant for keyboard
-   * accelerators. The default mod mask is Gdk::CONTROL_MASK |
-   * Gdk::SHIFT_MASK | Gdk::MOD1_MASK, that is, Control, Shift, and Alt.
+   * accelerators. The default mod mask is Gdk::ModifierType::CONTROL_MASK |
+   * Gdk::ModifierType::SHIFT_MASK | Gdk::ModifierType::MOD1_MASK, that is, Control, Shift, and Alt.
    * Other modifiers will ignored by default.
    * You must include at least the three default modifiers in any
    * value you pass to this function.
diff --git a/gtk/src/adjustment.hg b/gtk/src/adjustment.hg
index ef3451e..dc393e8 100644
--- a/gtk/src/adjustment.hg
+++ b/gtk/src/adjustment.hg
@@ -29,7 +29,7 @@ namespace Gtk
  * lower and upper bound, together with step and page increments, and a page
  * size.  It is used within several gtkmm widgets, including
  * Gtk::SpinButton, Gtk::Viewport, and Gtk::Range (which is a base class for
- * Gtk::HScrollbar, Gtk::VScrollbar, Gtk::HScale, and Gtk::VScale).
+ * Gtk::Scrollbar and Gtk::Scale).
  *
  * The Gtk::Adjustment object does not update the value itself. Instead it
  * is left up to the owner of the Gtk::Adjustment to control the value.
diff --git a/gtk/src/button.hg b/gtk/src/button.hg
index ed4f019..9d0a90d 100644
--- a/gtk/src/button.hg
+++ b/gtk/src/button.hg
@@ -90,7 +90,7 @@ public:
    * @param icon_name An icon name.
    * @param size An icon size. Can be either an IconSize or a BuiltinIconSize.
    * @param use_fallback Whether the icon displayed in the Gtk::Image will use
-   *        standard icon names fallback. See also Gtk::ICON_LOOKUP_GENERIC_FALLBACK.
+   *        standard icon names fallback. See also Gtk::IconLookupFlags::GENERIC_FALLBACK.
    *
    * @newin{3,12}
    */
diff --git a/gtk/src/enums.hg b/gtk/src/enums.hg
index 1d2842a..8bc27dd 100644
--- a/gtk/src/enums.hg
+++ b/gtk/src/enums.hg
@@ -92,7 +92,7 @@ public:
   operator int() const { return size_; }
 
   /** Obtains the pixel size of a semantic icon size, possibly modified by user preferences for the default 
Gtk::Settings.
-   * Normally size would be Gtk::ICON_SIZE_MENU, Gtk::ICON_SIZE_BUTTON, etc.
+   * Normally size would be Gtk::BuiltinIconSize::MENU, Gtk::BuiltinIconSize::BUTTON, etc.
    * This function isn't normally needed because Gtk::Widget::render_icon() is the usual way to get an icon 
for
    * rendering - then just look at the size of the rendered pixbuf. The rendered pixbuf may not even 
correspond
    * to the width/height returned by IconSize::lookup(), because themes are free to render the pixbuf 
however they
diff --git a/gtk/src/gesture.hg b/gtk/src/gesture.hg
index 3562000..24f6fdb 100644
--- a/gtk/src/gesture.hg
+++ b/gtk/src/gesture.hg
@@ -59,7 +59,7 @@ _WRAP_ENUM(EventSequenceState, GtkEventSequenceState)
  *
  * After the capture phase, GTK+ emits the traditional Widget::signal_button_press_event(),
  * Widget::signal_button_release_event(), Widget::signal_touch_event(), etc. Gestures
- * with the Gtk::PHASE_TARGET phase are fed events from the default
+ * with the Gtk::PropagationPhase::TARGET phase are fed events from the default
  * Widget::signal_event() handlers.
  *
  * In the bubble phase, events are propagated up from the target widget to the
@@ -80,28 +80,28 @@ _WRAP_ENUM(EventSequenceState, GtkEventSequenceState)
  * set_sequence_state() on one will effectively propagate
  * the state throughout the group.
  *
- * By default, all sequences start out in the Gtk::EVENT_SEQUENCE_NONE state.
+ * By default, all sequences start out in the Gtk::EventSequenceState::NONE state.
  * Sequences in this state trigger the gesture event handler, but event
  * propagation will continue unstopped by gestures.
  *
- * If a sequence enters into the Gtk::EVENT_SEQUENCE_DENIED state, the gesture
+ * If a sequence enters into the Gtk::EventSequenceState::DENIED state, the gesture
  * group will effectively ignore the sequence, letting events go unstopped
  * through the gesture, but the "slot" will still remain occupied while
  * the touch is active.
  *
- * If a sequence enters in the Gtk::EVENT_SEQUENCE_CLAIMED state, the gesture
+ * If a sequence enters in the Gtk::EventSequenceState::CLAIMED state, the gesture
  * group will grab all interaction on the sequence, by:
- * - Setting the same sequence to Gtk::EVENT_SEQUENCE_DENIED on every other gesture
+ * - Setting the same sequence to Gtk::EventSequenceState::DENIED on every other gesture
  *   group within the widget, and every gesture on parent widgets in the propagation
  *   chain.
  * - emitting signal_cancel() on every gesture in widgets underneath in the
  *   propagation chain.
  * - Stopping event propagation after the gesture group handles the event.
  *
- * @note If a sequence is set early to Gtk::EVENT_SEQUENCE_CLAIMED on
- * Gdk::TOUCH_BEGIN/Gdk::BUTTON_PRESS (so those events are captured before
- * reaching the event widget, this implies Gtk::PHASE_CAPTURE), one similar
- * event will be emulated if the sequence changes to Gtk::EVENT_SEQUENCE_DENIED.
+ * @note If a sequence is set early to Gtk::EventSequenceState::CLAIMED on
+ * Gdk::Event::Type::TOUCH_BEGIN/Gdk::Event::Type::BUTTON_PRESS (so those events are captured before
+ * reaching the event widget, this implies Gtk::PropagationPhase::CAPTURE), one similar
+ * event will be emulated if the sequence changes to Gtk::EventSequenceState::DENIED.
  * This way event coherence is preserved before event propagation is unstopped
  * again.
  *
diff --git a/gtk/src/grid.hg b/gtk/src/grid.hg
index d4528b7..b85532d 100644
--- a/gtk/src/grid.hg
+++ b/gtk/src/grid.hg
@@ -67,7 +67,7 @@ public:
    * (for top or bottom placement), at the end indicated by @a side.
    *
    * Attaching widgets labeled [1], [2], [3] without the @a sibling parameter and
-   * @a side == Gtk::POS_LEFT yields a layout of [3][2][1].
+   * @a side == Gtk::PositionType::LEFT yields a layout of [3][2][1].
    *
    * @param child The widget to add.
    * @param sibling The child of @a grid that @a child will be placed
diff --git a/gtk/src/levelbar.hg b/gtk/src/levelbar.hg
index 0910e4b..ae53bf4 100644
--- a/gtk/src/levelbar.hg
+++ b/gtk/src/levelbar.hg
@@ -42,7 +42,7 @@ namespace Gtk
  * set_max_value(). The value will be always drawn in proportion to
  * the admissible interval, i.e. a value of 15 with a specified interval between
  * 10 and 20 is equivalent to a value of 0.5 with an interval between 0 and 1.
- * When Gtk::LEVEL_BAR_MODE_DISCRETE is used, the bar level is rendered
+ * When Gtk::LevelBar::Mode::DISCRETE is used, the bar level is rendered
  * as a finite and number of separated blocks instead of a single one. The number
  * of blocks that will be rendered is equal to the number of units specified by
  * the admissible interval.
diff --git a/gtk/src/overlay.hg b/gtk/src/overlay.hg
index e0c1958..7bd4815 100644
--- a/gtk/src/overlay.hg
+++ b/gtk/src/overlay.hg
@@ -29,9 +29,9 @@ namespace Gtk
  * of which it can place “overlay” widgets. The
  * position of each overlay widget is determined by its Gtk::Widget:halign
  * and Gtk::Widget:valign properties. E.g. a widget with both alignments
- * set to Gtk::ALIGN_START will be placed at the top left corner of the
- * main widget, whereas an overlay with halign set to Gtk::ALIGN_CENTER
- * and valign set to Gtk::ALIGN_END will be placed a the bottom edge of
+ * set to Gtk::Align::START will be placed at the top left corner of the
+ * main widget, whereas an overlay with halign set to Gtk::Align::CENTER
+ * and valign set to Gtk::Align::END will be placed a the bottom edge of
  * the main widget, horizontally centered. The position can be adjusted
  * by setting the margin properties of the child to non-zero values.
  *
diff --git a/gtk/src/paned.hg b/gtk/src/paned.hg
index 2a15e98..d2da12b 100644
--- a/gtk/src/paned.hg
+++ b/gtk/src/paned.hg
@@ -41,7 +41,7 @@ namespace Gtk
  * handle that the user can drag to adjust the division. It does not draw any
  * relief around the children or around the separator.  (The space
  * in which the separator is called the gutter.) Often, it is useful to
- * put each child inside a Gtk::Frame with the shadow type set to Gtk::SHADOW_IN
+ * put each child inside a Gtk::Frame with the shadow type set to Gtk::ShadowType::IN
  * so that the gutter appears as a ridge. No separator is drawn if one of
  * the children is missing.
  *
diff --git a/gtk/src/sizegroup.hg b/gtk/src/sizegroup.hg
index 6340159..52a4b1f 100644
--- a/gtk/src/sizegroup.hg
+++ b/gtk/src/sizegroup.hg
@@ -43,8 +43,8 @@ _CC_INCLUDE(gtk/gtk.h)
  *
  * Widgets can be part of multiple size groups; GTK+ will compute the horizontal size of a widget from the 
horizontal
  * requisition of all widgets that can be reached from the widget by a chain of size groups of type
- * Gtk::SIZE_GROUP_HORIZONTAL or Gtk::SIZE_GROUP_BOTH, and the vertical size from the vertical requisition 
of all widgets
- * that can be reached from the widget by a chain of size groups of type Gtk::SIZE_GROUP_VERTICAL or 
Gtk::SIZE_GROUP_BOTH.
+ * Gtk::SizeGroup::Mode::HORIZONTAL or Gtk::SizeGroup::Mode::BOTH, and the vertical size from the vertical 
requisition of all widgets
+ * that can be reached from the widget by a chain of size groups of type Gtk::SizeGroup::Mode::VERTICAL or 
Gtk::SizeGroup::Mode::BOTH.
  */
 class SizeGroup
   : public Glib::Object,
diff --git a/gtk/src/treeiter.hg b/gtk/src/treeiter.hg
index 23e385e..f56df58 100644
--- a/gtk/src/treeiter.hg
+++ b/gtk/src/treeiter.hg
@@ -189,7 +189,7 @@ protected:
  * Although generally uninteresting, as one always has to
  * allow for the case where iterators do not persist beyond a signal, some very
  * important performance enhancements were made in the sort model. As a result,
- * the Gtk::TREE_MODEL_ITERS_PERSIST flag was added to indicate this behaviour -
+ * the Gtk::TreeModel::Flags::ITERS_PERSIST flag was added to indicate this behaviour -
  * see Gtk::TreeModel::get_flags().
  *
  * @tparam T TreeRow for an iterator, TreeConstRow for a const_iterator.
diff --git a/gtk/src/treeselection.hg b/gtk/src/treeselection.hg
index 98a1e2d..9bb1b30 100644
--- a/gtk/src/treeselection.hg
+++ b/gtk/src/treeselection.hg
@@ -94,7 +94,7 @@ public:
   /** Get the currently selected row.
    * @return The currently selected row. Or an invalid iterator, if no row is selected.
    * @note
-   * This method won't work if the selection mode is <tt>Gtk::SELECTION_MULTIPLE</tt>.
+   * This method won't work if the selection mode is <tt>Gtk::SelectionMode::MULTIPLE</tt>.
    * Use get_selected_rows() for multiple selections.
    */
   TreeModel::iterator get_selected();
@@ -102,7 +102,7 @@ public:
   /** Get the currently selected row.
    * @return The currently selected row. Or an invalid iterator, if no row is selected.
    * @note
-   * This method won't work if the selection mode is <tt>Gtk::SELECTION_MULTIPLE</tt>.
+   * This method won't work if the selection mode is <tt>Gtk::SelectionMode::MULTIPLE</tt>.
    * Use get_selected_rows() for multiple selections.
    *
    * @newin{3,90}
@@ -113,7 +113,7 @@ public:
    * @param[out] model The current TreeModel.
    * @return The currently selected row. Or an invalid iterator, if no row is selected.
    * @note
-   * This method won't work if the selection mode is <tt>Gtk::SELECTION_MULTIPLE</tt>.
+   * This method won't work if the selection mode is <tt>Gtk::SelectionMode::MULTIPLE</tt>.
    * Use get_selected_rows() for multiple selections.
    */
   TreeModel::iterator get_selected(Glib::RefPtr<TreeModel>& model);
@@ -122,7 +122,7 @@ public:
    * @param[out] model The current TreeModel.
    * @return The currently selected row. Or an invalid iterator, if no row is selected.
    * @note
-   * This method won't work if the selection mode is <tt>Gtk::SELECTION_MULTIPLE</tt>.
+   * This method won't work if the selection mode is <tt>Gtk::SelectionMode::MULTIPLE</tt>.
    * Use get_selected_rows() for multiple selections.
    *
    * @newin{3,90}
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]