aboutsummaryrefslogblamecommitdiffstats
path: root/widgets/misc/e-canvas.h
blob: 5cdcc4ab908ea6b62d1c672220e648fe17c8c862 (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                           





                                     

                                                                

                                                                    
  

                                                                      
                                                                    
                                                   
  



                                                                      
   
 


                      
                                        










                                                                  



                                                                                                        
 

                                                                                         
 









                                                                                             


                                           





                                                        


                                                                                                            
                                                      

  




                              

                                                                                                 

               




                                        
 



                                                   
                 


                                                
      




                                                   




                                      
                                          


  

                                                                
 


                                                                         


























                                                                                                           

                          






                                                                                                   
 





                           
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-canvas.h
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef __E_CANVAS_H__
#define __E_CANVAS_H__

#include <libgnomecanvas/gnome-canvas.h>

#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus */

/* ECanvas - A class derived from canvas for the purpose of adding
 * evolution specific canvas hacks.
 */

#define E_CANVAS_TYPE           (e_canvas_get_type ())
#define E_CANVAS(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_CANVAS_TYPE, ECanvas))
#define E_CANVAS_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), E_CANVAS_TYPE, ECanvasClass))
#define E_IS_CANVAS(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_CANVAS_TYPE))
#define E_IS_CANVAS_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((obj), E_CANVAS_TYPE))

typedef void        (*ECanvasItemReflowFunc)        (GnomeCanvasItem *item,
                                 gint         flags);

typedef void            (*ECanvasItemSelectionFunc)             (GnomeCanvasItem *item,
                                 gint             flags,
                                 gpointer         user_data);
/* Returns the same as strcmp does. */
typedef gint            (*ECanvasItemSelectionCompareFunc)      (GnomeCanvasItem *item,
                                 gpointer         data1,
                                 gpointer         data2,
                                 gint             flags);


typedef struct _ECanvas       ECanvas;
typedef struct _ECanvasClass  ECanvasClass;

/* Object flags for items */
enum {
    E_CANVAS_ITEM_NEEDS_REFLOW            = 1 << 13,
    E_CANVAS_ITEM_DESCENDENT_NEEDS_REFLOW = 1 << 14
};

enum {
    E_CANVAS_ITEM_SELECTION_SELECT        = 1 << 0, /* TRUE = select.  FALSE = unselect. */
    E_CANVAS_ITEM_SELECTION_CURSOR        = 1 << 1, /* TRUE = has become cursor.  FALSE = not cursor. */
    E_CANVAS_ITEM_SELECTION_DELETE_DATA   = 1 << 2
};

typedef struct {
    GnomeCanvasItem *item;
    gpointer         id;
} ECanvasSelectionInfo;

typedef void (*ECanvasItemGrabCancelled) (ECanvas *canvas, GnomeCanvasItem *item, gpointer data);

struct _ECanvas
{
    GnomeCanvas parent;
                     
    int                   idle_id;
    GList                *selection;
    ECanvasSelectionInfo *cursor;

    GtkWidget            *tooltip_window;
    int                   visibility_notify_id;
    GtkWidget            *toplevel;
    guint visibility_first : 1;
#ifdef GAL_GDK_IM
    /* Input context for dead key support */
    GdkIC     *ic;
    GdkICAttr *ic_attr;
#endif

    ECanvasItemGrabCancelled grab_cancelled_cb;
    guint grab_cancelled_check_id;
    guint32 grab_cancelled_time;
    gpointer grab_cancelled_data;
};

struct _ECanvasClass
{
    GnomeCanvasClass parent_class;
    void (* reflow) (ECanvas *canvas);
};


GtkType    e_canvas_get_type                             (void);
GtkWidget *e_canvas_new                                  (void);

/* Used to send all of the keystroke events to a specific item as well as
 * GDK_FOCUS_CHANGE events.
 */
void       e_canvas_item_grab_focus                      (GnomeCanvasItem                 *item,
                              gboolean                         widget_too);
void       e_canvas_item_request_reflow                  (GnomeCanvasItem                 *item);
void       e_canvas_item_request_parent_reflow           (GnomeCanvasItem                 *item);
void       e_canvas_item_set_reflow_callback             (GnomeCanvasItem                 *item,
                              ECanvasItemReflowFunc            func);
void       e_canvas_item_set_selection_callback          (GnomeCanvasItem                 *item,
                              ECanvasItemSelectionFunc         func);
void       e_canvas_item_set_selection_compare_callback  (GnomeCanvasItem                 *item,
                              ECanvasItemSelectionCompareFunc  func);
void       e_canvas_item_set_cursor                      (GnomeCanvasItem                 *item,
                              gpointer                         id);
void       e_canvas_item_add_selection                   (GnomeCanvasItem                 *item,
                              gpointer                         id);
void       e_canvas_item_remove_selection                (GnomeCanvasItem                 *item,
                              gpointer                         id);

int        e_canvas_item_grab                            (ECanvas                         *canvas,
                              GnomeCanvasItem                 *item,
                              guint                            event_mask,
                              GdkCursor                       *cursor,
                              guint32                          etime,
                              ECanvasItemGrabCancelled         cancelled,
                              gpointer                         cancelled_data);
void       e_canvas_item_ungrab                          (ECanvas                         *canvas,
                              GnomeCanvasItem                 *item,
                              guint32                          etime);

/* Not implemented yet. */
void       e_canvas_item_set_cursor_end                  (GnomeCanvasItem                 *item,
                              gpointer                         id);
void       e_canvas_popup_tooltip                        (ECanvas                         *canvas,
                              GtkWidget                       *widget,
                              int                              x,
                              int                              y);
void       e_canvas_hide_tooltip                         (ECanvas                         *canvas);

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __E_CANVAS_H__ */