libgtkmm-3.0-dev 3.14.0-1 / usr / include / gtkmm-3.0 / gtkmm / gesturesingle.h

// -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GTKMM_GESTURESINGLE_H
#define _GTKMM_GESTURESINGLE_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/gesture.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkGestureSingle GtkGestureSingle;
typedef struct _GtkGestureSingleClass GtkGestureSingleClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gtk
{ class GestureSingle_Class; } // namespace Gtk
namespace Gtk
{
/** Abstract base class for mouse/single-touch gestures.
 *
 * This is a subclass of Gesture, optimized (although
 * not restricted) for dealing with mouse and single-touch gestures. Under
 * interaction, these gestures stick to the first interacting sequence, which
 * is accessible through get_current_sequence() while the
 * gesture is being interacted with.
 *
 * By default gestures only react to touch events. set_touch_only()
 * can be used to change this default behavior. Callers may also specify
 * a mouse button number to interact with through set_button().
 *
 * @newin{3,14}
 *
 * @ingroup Gestures
 */

class GestureSingle : public Gesture
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  typedef GestureSingle CppObjectType;
  typedef GestureSingle_Class CppClassType;
  typedef GtkGestureSingle BaseObjectType;
  typedef GtkGestureSingleClass BaseClassType;

private:  friend class GestureSingle_Class;
  static CppClassType gesturesingle_class_;

private:
  // noncopyable
  GestureSingle(const GestureSingle&);
  GestureSingle& operator=(const GestureSingle&);

protected:
  explicit GestureSingle(const Glib::ConstructParams& construct_params);
  explicit GestureSingle(GtkGestureSingle* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  virtual ~GestureSingle();

  /** 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.
  GtkGestureSingle*       gobj()       { return reinterpret_cast<GtkGestureSingle*>(gobject_); }

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

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

private:


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

public:
  // No create() because only derived classes shall be instantiated.

  
  /** Returns <tt>true</tt> if the gesture is only triggered by touch events.
   * 
   * @newin{3,14}
   * 
   * @return <tt>true</tt> if the gesture only handles touch events.
   */
  bool get_touch_only() const;
  
  /** If @a touch_only is <tt>true</tt>, @a gesture will only handle events of type
   * Gdk::TOUCH_BEGIN, Gdk::TOUCH_UPDATE or Gdk::TOUCH_END. If <tt>false</tt>,
   * mouse events will be handled too.
   * 
   * @newin{3,14}
   * 
   * @param touch_only Whether @a gesture handles only touch events.
   */
  void set_touch_only(bool touch_only =  true);
  
  /** Gets whether a gesture is exclusive. For more information, see
   * set_exclusive().
   * 
   * @newin{3,14}
   * 
   * @return Whether the gesture is exclusive.
   */
  bool get_exclusive() const;
  
  /** Sets whether @a gesture is exclusive. An exclusive gesture will
   * only handle pointer and "pointer emulated" touch events, so at
   * any given time, there is only one sequence able to interact with
   * those.
   * 
   * @newin{3,14}
   * 
   * @param exclusive <tt>true</tt> to make @a gesture exclusive.
   */
  void set_exclusive(bool exclusive =  true) const;
  
  /** Returns the button number @a gesture listens for, or 0 if @a gesture
   * reacts to any button press.
   * 
   * @newin{3,14}
   * 
   * @return The button number, or 0 for any button.
   */
  unsigned int get_button() const;
  
  /** Sets the button number @a gesture listens to. If non-0, every
   * button press from a different button number will be ignored.
   * Touch events implicitly match with button 1.
   * 
   * @newin{3,14}
   * 
   * @param button Button number to listen to, or 0 for any button.
   */
  void set_button(unsigned int button =  0);
  
  /** Returns the button number currently interacting with @a gesture, or 0 if there
   * is none.
   * 
   * @newin{3,14}
   * 
   * @return The current button number.
   */
  unsigned int get_current_button() const;
  
  /** Returns the event sequence currently interacting with @a gesture.
   * This is only meaningful if is_active() returns <tt>true</tt>.
   * 
   * @newin{3,14}
   * 
   * @return The current sequence.
   */
  GdkEventSequence* get_current_sequence();
  
  /** Returns the event sequence currently interacting with @a gesture.
   * This is only meaningful if is_active() returns <tt>true</tt>.
   * 
   * @newin{3,14}
   * 
   * @return The current sequence.
   */
  const GdkEventSequence* get_current_sequence() const;

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the gesture handles only touch events.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy< bool > property_touch_only() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the gesture handles only touch events.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< bool > property_touch_only() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the gesture is exclusive.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy< bool > property_exclusive() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether the gesture is exclusive.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< bool > property_exclusive() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Button number to listen to.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy< unsigned int > property_button() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Button number to listen to.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
   * or receive notification when the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< unsigned int > property_button() const;
#endif //#GLIBMM_PROPERTIES_ENABLED


  // GestureSingle has no signals


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::GestureSingle
   */
  Glib::RefPtr<Gtk::GestureSingle> wrap(GtkGestureSingle* object, bool take_copy = false);
}


#endif /* _GTKMM_GESTURESINGLE_H */