comparison lisp/textmodes/artist.el @ 107128:0241cf43ec95

* textmodes/artist.el (artist-mt): Fix typos in docstring.
author Juanma Barranquero <lekktu@gmail.com>
date Thu, 11 Feb 2010 01:02:43 +0100
parents b3b9ebd930e1
children 0fee5a19e171
comparison
equal deleted inserted replaced
107127:a6b946ca8797 107128:0241cf43ec95
857 the shape. 857 the shape.
858 ARROW-PRED is a function that is called to find out if the shape 858 ARROW-PRED is a function that is called to find out if the shape
859 can have arrows. The function is called with no arguments and 859 can have arrows. The function is called with no arguments and
860 must return nil or t. 860 must return nil or t.
861 ARROW-SET-FN is a function that is called to set arrow end-points. 861 ARROW-SET-FN is a function that is called to set arrow end-points.
862 Arguments and return values for this funcion are described below. 862 Arguments and return values for this function are described below.
863 INIT-FN is, if non-nil, a function that is called when the first 863 INIT-FN is, if non-nil, a function that is called when the first
864 point of the shape is set. Arguments and return values for 864 point of the shape is set. Arguments and return values for
865 this funcion are described below. 865 this function are described below.
866 PREP-FILL-FN is, if non-nil, a function that is called after 866 PREP-FILL-FN is, if non-nil, a function that is called after
867 the last point is set, but before the filling is done. 867 the last point is set, but before the filling is done.
868 Arguments and return values for this funcion are described below. 868 Arguments and return values for this function are described below.
869 EXIT-FN is, if non-nil, a function that is called after filling 869 EXIT-FN is, if non-nil, a function that is called after filling
870 is done. Arguments and return values for this funcion are 870 is done. Arguments and return values for this function are
871 described below. 871 described below.
872 DRAW-HOW defines the kind of shape. The kinds of shapes are: 872 DRAW-HOW defines the kind of shape. The kinds of shapes are:
873 `artist-do-continously' -- Do drawing operation continuously, 873 `artist-do-continously' -- Do drawing operation continuously,
874 as long as the mouse button is held down. 874 as long as the mouse button is held down.
875 `artist-do-poly' -- Do drawing operation many times. 875 `artist-do-poly' -- Do drawing operation many times.
876 1 -- Do drawing operation only once. 876 1 -- Do drawing operation only once.
877 2 -- The drawing operation requires two points. 877 2 -- The drawing operation requires two points.
878 DRAW-FN is the function to call for drawing. Arguments and 878 DRAW-FN is the function to call for drawing. Arguments and
879 return values for this funcion are described below. 879 return values for this function are described below.
880 EXTRA-DRAW-INFO the layout of this depends on the value of DRAW-HOW: 880 EXTRA-DRAW-INFO the layout of this depends on the value of DRAW-HOW:
881 If DRAW-HOW is `artist-do-continously': 881 If DRAW-HOW is `artist-do-continously':
882 882
883 (INTERVAL-FN) 883 (INTERVAL-FN)
884 884
892 If DRAW-HOW is either `artist-do-poly' or 2: 892 If DRAW-HOW is either `artist-do-poly' or 2:
893 893
894 (UNDRAW-FN FILL-PRED FILL-FN) 894 (UNDRAW-FN FILL-PRED FILL-FN)
895 895
896 UNDRAW-FN is a function to call for undrawing the shape. 896 UNDRAW-FN is a function to call for undrawing the shape.
897 Arguments and return values for this funcion are 897 Arguments and return values for this function are
898 described below. 898 described below.
899 FILL-PRED is a function that is called to find out if the shape 899 FILL-PRED is a function that is called to find out if the shape
900 can have arrows. The function must take no arguments and 900 can have arrows. The function must take no arguments and
901 return nil or t. 901 return nil or t.
902 FILL-FN is a function to call for filling the shape. 902 FILL-FN is a function to call for filling the shape.
903 Arguments and return values for this funcion are 903 Arguments and return values for this function are
904 described below. 904 described below.
905 905
906 If DRAW-HOW is 1: 906 If DRAW-HOW is 1:
907 907
908 () 908 ()
909 909
910 Note! All symbols and keywords (both in the `funcion-call' INFO-PART 910 Note! All symbols and keywords (both in the `function-call' INFO-PART
911 as well as in the `graphics-operation' INFO-PART) must be unique. 911 as well as in the `graphics-operation' INFO-PART) must be unique.
912 912
913 The following table describe function arguments and return value 913 The following table describe function arguments and return value
914 for different functions and DRAW-HOWs. 914 for different functions and DRAW-HOWs.
915 915