[Previous] [Up] [Next]
Go backward to Preparing input for Ipe
Go up to Interfacing with Ipe
Go forward to The different entries in an Ipe format file

The interface files between Ipe and Ipe user macros

When Ipe calls an Ipe user macro, it first writes a file with a description of Ipe's current state and all the currently selected objects. This file has the following format:

%\IUMid{ipe_version}
% Settings
% ss line_style line_width
% ar arrow_mode arrow_size
% ty mark_type
% sz mark_size
% f  font fontsize
% grid gridsize snap_angle
% sk stroke_color
% fi fill_color
% axis origin_x origin_y axis_dir
% End
entry_1
entry_2
...
% Primary
entry_i
...
entry_n
% End
Here, entry_i is the current primary selection, and the remaining entries correspond to the secondary selection, all in back to front order. For the exact encoding of the values in the Settings part, see the description of the different entries. (Note that the two colors can also be specified with a skc and fic keyword, if they are not gray). You should not assume any particular order of the fields in the Settings entry, and you should accept and ignore any keywords not listed above, to make your Ium compatible with future versions of Ipe.

After execution of the Ium, Ipe expects that it has written its output into the same file used as input file. The format is as follows:

%\IUMid{ium_version}
% Interface mode message
entry_1
entry_2
...
entry_n
% End
The mode should be an integer between 0 and 4 that tells Ipe what to do with the entries. They correspond to the modes IUM_SELECT_OLD, IUM_SELECT_NEW, IUM_SELECT_BOTH, IUM_REPLACE, and IUM_DELETE_OLD described elsewhere. The message is printed by Ipe in the message field. Use this for non-fatal error messages, or to tell the user about the completion of the operation, like "Voronoi diagram computed".


[Previous] [Up] [Next]