libgtkmm-3.0-dev 3.22.0-1 / usr / include / gtkmm-3.0 / gtkmm / gesturemultipress.h

// Generated by gmmproc 2.50.0 -- DO NOT MODIFY!
#ifndef _GTKMM_GESTUREMULTIPRESS_H
#define _GTKMM_GESTUREMULTIPRESS_H


#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>

/* Copyright (C) 2014 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

#include <gtkmm/gesturesingle.h>
#include <gdkmm/rectangle.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GtkGestureMultiPress = struct _GtkGestureMultiPress;
using GtkGestureMultiPressClass = struct _GtkGestureMultiPressClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class GestureMultiPress_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS

namespace Gtk
{
/** Multipress gesture.
 *
 * This is a Gesture implementation able to recognize
 * multiple clicks on a nearby zone, which can be listened for through
 * signal_pressed(). Whenever time or distance between
 * clicks exceed the GTK+ defaults, signal_stopped() is emitted,
 * and the click counter is reset.
 *
 * Callers may also restrict the area that is considered valid for a >1
 * touch/button press through set_area(), so any
 * click happening outside that area is considered to be a first click of
 * its own.
 *
 * @newin{3,14}
 *
 * @ingroup Gestures
 */

class GestureMultiPress : public GestureSingle
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  using CppObjectType = GestureMultiPress;
  using CppClassType = GestureMultiPress_Class;
  using BaseObjectType = GtkGestureMultiPress;
  using BaseClassType = GtkGestureMultiPressClass;

  // noncopyable
  GestureMultiPress(const GestureMultiPress&) = delete;
  GestureMultiPress& operator=(const GestureMultiPress&) = delete;

private:  friend class GestureMultiPress_Class;
  static CppClassType gesturemultipress_class_;

protected:
  explicit GestureMultiPress(const Glib::ConstructParams& construct_params);
  explicit GestureMultiPress(GtkGestureMultiPress* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:

  GestureMultiPress(GestureMultiPress&& src) noexcept;
  GestureMultiPress& operator=(GestureMultiPress&& src) noexcept;

  ~GestureMultiPress() noexcept override;

  /** Get the GType for this class, for use with the underlying GObject type system.
   */
  static GType get_type()      G_GNUC_CONST;

#ifndef DOXYGEN_SHOULD_SKIP_THIS


  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GObject.
  GtkGestureMultiPress*       gobj()       { return reinterpret_cast<GtkGestureMultiPress*>(gobject_); }

  ///Provides access to the underlying C GObject.
  const GtkGestureMultiPress* gobj() const { return reinterpret_cast<GtkGestureMultiPress*>(gobject_); }

  ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  GtkGestureMultiPress* gobj_copy();

private:


protected:
  /** There is no create() method that corresponds to this constructor,
   * because this constructor shall only be used by derived classes.
   */
  GestureMultiPress();

  /** Constructs a Gesture that recognizes single and multiple presses.
   */
    explicit GestureMultiPress(Widget& widget);


public:
  /** Creates a Gesture that recognizes single and multiple presses.
   *
   * @newin{3,14}
   *
   * @param widget Widget the gesture relates to.
   * @return A RefPtr to a new GestureMultiPress.
   */
  
  static Glib::RefPtr<GestureMultiPress> create(Widget& widget);


  /** If an area was set through set_area(),
   * this function will return <tt>true</tt> and fill in @a rect with the
   * press area. See set_area() for more
   * details on what the press area represents.
   * 
   * @newin{3,14}
   * 
   * @param rect Return location for the press area.
   * @return <tt>true</tt> if @a rect was filled with the press area.
   */
  bool get_area(Gdk::Rectangle& rect) const;
  
  /** If @a rect is non-<tt>nullptr</tt>, the press area will be checked to be
   * confined within the rectangle, otherwise the button count
   * will be reset so the press is seen as being the first one.
   * If @a rect is #<tt>nullptr</tt>, the area will be reset to an unrestricted
   * state.
   * 
   * @note The rectangle is only used to determine whether any
   * non-first click falls within the expected area. This is not
   * akin to an input shape.
   * 
   * @newin{3,14}
   * 
   * @param rect Rectangle to receive coordinates on.
   */
  void set_area(const Gdk::Rectangle& rect);

  /** Resets the press area to an unrestricted state.
   *
   * @newin{3,14}
   */
  void unset_area();

  // no_default_handler because GtkGestureMultiPressClass is private.
  
  /**
   * @par Slot Prototype:
   * <tt>void on_my_%pressed(int n_press, double x, double y)</tt>
   *
   * This signal is emitted whenever a button or touch press happens.
   * 
   * @newin{3,14}
   * 
   * @param n_press How many touch/button presses happened with this one.
   * @param x The X coordinate, in widget allocation coordinates.
   * @param y The Y coordinate, in widget allocation coordinates.
   */

  Glib::SignalProxy< void,int,double,double > signal_pressed();

  
  /**
   * @par Slot Prototype:
   * <tt>void on_my_%released(int n_press, double x, double y)</tt>
   *
   * This signal is emitted when a button or touch is released. @a n_press
   * will report the number of press that is paired to this event, note
   * that Gtk::GestureMultiPress::signal_stopped() may have been emitted between the
   * press and its release, @a n_press will only start over at the next press.
   * 
   * @newin{3,14}
   * 
   * @param n_press Number of press that is paired with this release.
   * @param x The X coordinate, in widget allocation coordinates.
   * @param y The Y coordinate, in widget allocation coordinates.
   */

  Glib::SignalProxy< void,int,double,double > signal_released();

  
  /**
   * @par Slot Prototype:
   * <tt>void on_my_%stopped()</tt>
   *
   * This signal is emitted whenever any time/distance threshold has
   * been exceeded.
   * 
   * @newin{3,14}
   */

  Glib::SignalProxy< void > signal_stopped();


  // GestureMultiPress has no properties


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


};

} // namespace Gtk


namespace Glib
{
  /** A Glib::wrap() method for this object.
   *
   * @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.
   *
   * @relates Gtk::GestureMultiPress
   */
  Glib::RefPtr<Gtk::GestureMultiPress> wrap(GtkGestureMultiPress* object, bool take_copy = false);
}


#endif /* _GTKMM_GESTUREMULTIPRESS_H */