/* Dia -- an diagram creation/manipulation program -*- c -*- * Copyright (C) 1998 Alexander Larsson * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef OBJECT_H #define OBJECT_H #include typedef guint16 ObjectId; /* The id of an objecttype */ typedef struct _Object Object; typedef struct _ObjectOps ObjectOps; typedef struct _ObjectType ObjectType; typedef struct _ObjectTypeOps ObjectTypeOps; typedef enum _ModifierKeys ModifierKeys; #include "geometry.h" #include "render.h" #include "connectionpoint.h" #include "handle.h" #include "objchange.h" #include "diamenu.h" #include "dia_xml.h" #include "properties.h" /* This enumeration gives a bitset of modifier keys currently held down. */ enum _ModifierKeys { MODIFIER_NONE, MODIFIER_LEFT_SHIFT, MODIFIER_RIGHT_SHIFT, MODIFIER_SHIFT, MODIFIER_LEFT_ALT = 4, MODIFIER_RIGHT_ALT = 8, MODIFIER_ALT = 12, MODIFIER_LEFT_CONTROL = 16, MODIFIER_RIGHT_CONTROL = 32, MODIFIER_CONTROL = 48 }; /************************************ ** Some general function prototypes ** ** These are the prototypes for the ** functions that must be defined for ** every object we can insert in a ** diagram. ** ************************************/ /* Function called to create an object. This function is responsible for allocation memory for the object. - startpoint : initial position for the object - user_data : Can be used to pass extra params to the creation of the object. Can be used to have two icons of the same object that are instansiated a bit different. - handle1 : (return) Handle connected to startpoint - handle2 : (return) Handle dragged on creation both handle1 and handle2 can be NULL */ typedef Object* (*CreateFunc) (Point *startpoint, void *user_data, Handle **handle1, Handle **handle2); /* This function load the object's data from file fd. No header has to be skipped. The data should be read using the functions in lib/files.h The memory for the object has to be allocated (see CreateFunc) The version number is the version number of the ObjectType that was saved. This must be used to maintain backwards compatible if you change some in the save format. All objects must be capable of reading all earlier version. */ typedef Object* (*LoadFunc) (ObjectNode obj_node, int version, const char *filename); /* This function save the object's data to file fd. No header is required. The data should be written using the functions in lib/files.h */ typedef void (*SaveFunc) (Object* obj, ObjectNode obj_node, const char *filename); /* Function called before an object is deleted. This function must call the parent class's DestroyFunc, and then free the memory associated with the object, but not the object itself Must also unconnect itself from all other objects. (This is by calling object_destroy, or letting the super-class call it) */ typedef void (*DestroyFunc) (Object* obj); /* Function responsible for drawing the object. Every drawing must be done through the use of the Renderer, so that we can render the picture on screen, in an eps file, ... */ typedef void (*DrawFunc) (Object* obj, Renderer* ddisp); /* This function must return the distance between the Object and the Point. Several functions are provided in geometry.h to facilitate this calculus */ typedef real (*DistanceFunc) (Object* obj, Point* point); /* Function called once the object has been selected. Basically, this function should update the object (position of the handles,...) - clicked_point is the point on the screen where the user has clicked - interactive_renderer is a renderer that has some extra functions most notably the possibility to get EXACT measures of strings. Used to place cursors and other interactive stuff. (Don't draw to the renderer) This function need not redraw the object. */ typedef void (*SelectFunc) (Object* obj, Point* clicked_point, Renderer* interactive_renderer); /* Returns a copy of Object. This must be an depth-copy (pointers must be duplicated and so on) as the initial object can be deleted any time */ typedef Object* (*CopyFunc) (Object* obj); /* Function called to move the entire object. The new position is given by pos. It's exact definition depends on the object. It's the point on the object that 'snaps' to the grid if that is enabled. (generally it is the upper left corner) */ typedef void (*MoveFunc) (Object* obj, Point * pos); /* Function called to move one of the handles associated with the object. Its new position is given by pos. - reason gives the reason the handle was moved. HANDLE_MOVE_USER means the user is dragging the point. HANDLE_MOVE_USER_FINAL means the user let go of the point. HANDLE_MOVE_CONNECTED means it was moved because something it was connected to moved. - modifiers gives a bitset of modifier keys currently held down MODIFIER_SHIFT is either shift key MODIFIER_ALT is either alt key MODIFIER_CONTROL is either control key Each has MODIFIER_LEFT_* and MODIFIER_RIGHT_* variants */ typedef void (*MoveHandleFunc) (Object* obj, Handle* handle, Point* pos, HandleMoveReason reason, ModifierKeys modifiers); /* Function called when the user has double clicked on an Object. This function should return a dialog to edit the properties of the object. When this function is called and the dialog already is created, make sure to update the values in the widgets so that it accurately describes the current state of the object. Remember to destroy this dialog when the object is destroyed! Note that if you want to use the same dialog multiple times, you should ref it first. Just run the following on the widget when you create it: gtk_object_ref(GTK_OBJECT(widget)); gtk_object_sink(GTK_OBJECT(widget)); / * optional, but recommended * / If you don't do this, the widget will be destroyed when the properties dialog is closed. */ typedef GtkWidget *(*GetPropertiesFunc) (Object* obj); /* Thiss function is called when the user clicks on the "Apply" button. The widget parameter is the one created by the get_properties function. Must returns a Change that can be used for undo/redo. The returned change is already applied. */ typedef ObjectChange *(*ApplyPropertiesFunc) (Object* obj, GtkWidget *widget); /* This function is called to return a list of property descriptions the object supports. The list should be NULL terminated. */ typedef const PropDescription *(* DescribePropsFunc) (Object *obj); /* This function is called to return the current values (and type information) for a number of properties of the object. */ typedef void (* GetPropsFunc) (Object *obj, GPtrArray *props); /* This function is called to set the value of a number of properties of the object. */ typedef void (* SetPropsFunc) (Object *obj, GPtrArray *props); /* Function called when the user has double clicked on an Tool. This function should return a dialog to edit the defaults of the tool. When this function is called and the dialog already is created, make sure to update the values in the widgets so that it accurately describes the current state of the tool. */ typedef GtkWidget *(*GetDefaultsFunc) (); /* */ typedef void *(*ApplyDefaultsFunc) (); /* Return an object-specific menu with toggles etc. properly set. */ typedef DiaMenu *(*ObjectMenuFunc) (Object* obj, Point *position); /************************************* ** The functions provided in object.c *************************************/ void object_init(Object *obj, int num_handles, int num_connections); void object_destroy(Object *obj); /* Unconnects handles, so don't free handles before calling. */ void object_copy(Object *from, Object *to); void object_save(Object *obj, ObjectNode obj_node); void object_load(Object *obj, ObjectNode obj_node); void destroy_object_list(GList *list); void object_add_handle(Object *obj, Handle *handle); void object_add_handle_at(Object *obj, Handle *handle, int pos); void object_remove_handle(Object *obj, Handle *handle); void object_add_connectionpoint(Object *obj, ConnectionPoint *conpoint); void object_remove_connectionpoint(Object *obj, ConnectionPoint *conpoint); void object_add_connectionpoint_at(Object *obj, ConnectionPoint *conpoint, int pos); void object_connect(Object *obj, Handle *handle, ConnectionPoint *conpoint); void object_unconnect(Object *connected_obj, Handle *handle); void object_remove_connections_to(ConnectionPoint *conpoint); void object_unconnect_all(Object *connected_obj); void object_registry_init(void); void object_register_type(ObjectType *type); GSList *object_types_detect_nosheet(void); gchar *object_type_get_sheet_name(ObjectType *type); gchar *object_type_strip_sheet_from_name(ObjectType *type); ObjectType *object_get_type(char *name); int object_return_false(Object *obj); /* Just returns FALSE */ void *object_return_null(Object *obj); /* Just returns NULL */ void object_return_void(Object *obj); /* Just an empty function */ /* These functions can be used as a default implementation for an object which can be completely described, loaded and saved through standard properties. */ Object *object_load_using_properties(const ObjectType *type, ObjectNode obj_node, int version, const char *filename); void object_save_using_properties(Object *obj, ObjectNode obj_node, int version, const char *filename); Object *object_copy_using_properties(Object *obj); /***************************************** ** The structures used to define an object *****************************************/ /* This structure gives access to the functions used to manipulate an object See information above on the use of the functions */ struct _ObjectOps { DestroyFunc destroy; DrawFunc draw; DistanceFunc distance_from; SelectFunc selectf; CopyFunc copy; MoveFunc move; MoveHandleFunc move_handle; GetPropertiesFunc get_properties; ApplyPropertiesFunc apply_properties; ObjectMenuFunc get_object_menu; DescribePropsFunc describe_props; GetPropsFunc get_props; SetPropsFunc set_props; /* Unused places (for extension). These should be NULL for now. In the future they might be used. Then an older object will be binary compatible, because all new code checks if new ops are supported (!= NULL) */ void (*(unused[6]))(Object *obj,...); }; /* The base class in the Object hierarcy. All information in this structure read-only from the application point of view except when connection objects. (Then handles and connections are changed). position is not necessarly the corner of the object, but rather some 'good' spot on it which will be natural to snap to. */ struct _Object { ObjectType *type; Point position; Rectangle bounding_box; int num_handles; Handle **handles; int num_connections; ConnectionPoint **connections; ObjectOps *ops; }; struct _ObjectTypeOps { CreateFunc create; LoadFunc load; SaveFunc save; GetDefaultsFunc get_defaults; ApplyDefaultsFunc apply_defaults; /* Unused places (for extension). These should be NULL for now. In the future they might be used. Then an older object will be binary compatible, because all new code checks if new ops are supported (!= NULL) */ void (*(unused[10]))(Object *obj,...); }; /* Structure so that the ObjectFactory can create objects of unknown type. (Read in from a shared lib.) */ struct _ObjectType { char *name; int version; char **pixmap; /* Also put a pixmap in the sheet_object. This one is used if not in sheet but in toolbar. Stored in xpm format */ ObjectTypeOps *ops; char *pixmap_file; /* fallback if pixmap is NULL */ void *default_user_data; /* use this if no user data is specified in the .sheet file */ }; /* base property stuff ... */ #define OBJECT_COMMON_PROPERTIES \ { "obj_pos", PROP_TYPE_POINT, 0, \ "Object position", "Where the object is located"}, \ { "obj_bb", PROP_TYPE_RECT, 0, \ "Object bounding box", "The bounding box of the object"} #define OBJECT_COMMON_PROPERTIES_OFFSETS \ { "obj_pos", PROP_TYPE_POINT, offsetof(Object, position) }, \ { "obj_bb", PROP_TYPE_RECT, offsetof(Object, bounding_box) } #endif /* OBJECT_H */