src/knot.h

   1 #ifndef __SP_KNOT_H__
   2 #define __SP_KNOT_H__
   3
   4 /** \file
   5  * Declarations for SPKnot: Desktop-bound visual control object.
   6  */
   7 /*
   8  * Authors:
   9  *   Lauris Kaplinski <lauris@kaplinski.com>
  10  *
  11  * Copyright (C) 1999-2002 authors
  12  * Copyright (C) 2001-2002 Ximian, Inc.
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  */
  16
  17 #include <gdk/gdk.h>
  18 #include <gtk/gtkenums.h>
  19 #include "display/display-forward.h"
  20 #include "forward.h"
  21 #include <libnr/nr-point.h>
  22 #include "knot-enums.h"
  23
  24 class SPKnot;
  25 class SPKnotClass;
  26
  27 #define SP_TYPE_KNOT            (sp_knot_get_type())
  28 #define SP_KNOT(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), SP_TYPE_KNOT, SPKnot))
  29 #define SP_KNOT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), SP_TYPE_KNOT, SPKnotClass))
  30 #define SP_IS_KNOT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), SP_TYPE_KNOT))
  31 #define SP_IS_KNOT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), SP_TYPE_KNOT))
  32
  33 /**
  34  * Desktop-bound visual control object.
  35  *
  36  * A knot is a draggable object, with callbacks to change something by
  37  * dragging it, visuably represented by a canvas item (mostly square).
  38  */
  39 struct SPKnot {
  40     GObject object;
  41     SPDesktop *desktop;   /**< Desktop we are on. */
  42     SPCanvasItem *item;   /**< Our CanvasItem. */
  43     guint flags;
  44
  45     guint size;      /**< Always square. */
  46     NR::Point pos;   /**< Our desktop coordinates. */
  47     NR::Point grabbed_rel_pos;  /**< Grabbed relative position. */
  48     NR::Point drag_origin;      /**< Origin of drag. */
  49     GtkAnchorType anchor;    /**< Anchor. */
  50
  51     SPKnotShapeType shape;   /**< Shape type. */
  52     SPKnotModeType mode;
  53
  54     guint32 fill[SP_KNOT_VISIBLE_STATES];
  55     guint32 stroke[SP_KNOT_VISIBLE_STATES];
  56     guchar *image[SP_KNOT_VISIBLE_STATES];
  57
  58     GdkCursor *cursor[SP_KNOT_VISIBLE_STATES];
  59
  60     GdkCursor *saved_cursor;
  61     gpointer pixbuf;
  62
  63     gchar *tip;
  64 };
  65
  66 /// The SPKnot vtable.
  67 struct SPKnotClass {
  68     GObjectClass parent_class;
  69
  70     gint (* event) (SPKnot *knot, GdkEvent *event);
  71
  72     /*
  73      * These are unconditional.
  74      */
  75
  76     void (* clicked) (SPKnot *knot, guint state);
  77     void (* doubleclicked) (SPKnot *knot, guint state);
  78     void (* grabbed) (SPKnot *knot, guint state);
  79     void (* ungrabbed) (SPKnot *knot, guint state);
  80     void (* moved) (SPKnot *knot, NR::Point *position, guint state);
  81     void (* stamped) (SPKnot *know, guint state);
  82
  83     /** Request knot to move to absolute position. */
  84     bool (* request) (SPKnot *knot, NR::Point *pos, guint state);
  85
  86     /** Find complex distance from knot to point. */
  87     gdouble (* distance) (SPKnot *knot, NR::Point *pos, guint state);
  88 };
  89
  90 GType sp_knot_get_type();
  91
  92 SPKnot *sp_knot_new(SPDesktop *desktop, gchar const *tip = NULL);
  93
  94 #define SP_KNOT_IS_VISIBLE(k) ((k->flags & SP_KNOT_VISIBLE) != 0)
  95 #define SP_KNOT_IS_MOSEOVER(k) ((k->flags & SP_KNOT_MOUSEOVER) != 0)
  96 #define SP_KNOT_IS_DRAGGING(k) ((k->flags & SP_KNOT_DRAGGING) != 0)
  97 #define SP_KNOT_IS_GRABBED(k) ((k->flags & SP_KNOT_GRABBED) != 0)
  98
  99 void sp_knot_show(SPKnot *knot);
 100 void sp_knot_hide(SPKnot *knot);
 101
 102 void sp_knot_request_position(SPKnot *knot, NR::Point *pos, guint state);
 103 gdouble sp_knot_distance(SPKnot *knot, NR::Point *p, guint state);
 104
 105 void sp_knot_start_dragging(SPKnot *knot, NR::Point p, gint x, gint y, guint32 etime);
 106
 107 /** Moves knot and emits "moved" signal. */
 108 void sp_knot_set_position(SPKnot *knot, NR::Point *p, guint state);
 109
 110 /** Moves knot without any signal. */
 111 void sp_knot_moveto(SPKnot *knot, NR::Point *p);
 112
 113 NR::Point sp_knot_position(SPKnot const *knot);
 114
 115
 116 #endif /* !__SP_KNOT_H__ */
 117
 118 /*
 119   Local Variables:
 120   mode:c++
 121   c-file-style:"stroustrup"
 122   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 123   indent-tabs-mode:nil
 124   fill-column:99
 125   End:
 126 */
 127 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :