License header was missing
[scilab.git] / scilab / modules / graphics / macros / datatips / datatipSetDisplay.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 2010 - INRIA - Serge Steer <serge.steer@inria.fr>
3 //
4 // This file must be used under the terms of the CeCILL.
5 // This source file is licensed as described in the file COPYING, which
6 // you should have received as part of this distribution.  The terms
7 // are also available at;
8 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
9
10
11 function datatipSetDisplay(curve_handle,fun)
12 //Changes the datatips visualisation function for a given curve
13   ud=datatipGetStruct(curve_handle)
14   if typeof(ud)<>'datatips' then;
15     if ~datatipInitStruct(curve_handle) then return,end
16     ud=datatipGetStruct(curve_handle)
17   end
18   if argn(2)==1 then
19     // function definition is queried
20     txt=fun2string(ud.formatfunction,'fun')
21     while %t then
22       txt=x_dialog('Function Editor',txt)
23       if txt==[] then ok=%f,break,end
24       ierr=execstr(txt,'errcatch')
25       if ierr==0 then ok=%t,break,end
26       messagebox(lasterror(),'','error')
27     end
28     if ~ok then return,end
29   end
30   if ~datatipCheckFunction(fun) then return,end
31   ud.formatfunction=fun
32   datatipSetStruct(curve_handle,ud)
33   for k=1:size(ud.tips,'*')
34     tip_handle=ud.tips(k)
35     point_handle=tip_handle.children(1)
36     string_handle=tip_handle.children(2)
37     tip_index=point_handle.user_data(2)
38     string_handle.text=fun(curve_handle,point_handle.data)
39   end
40
41 endfunction
42 function ok=datatipCheckFunction(fun)
43   ok=%f
44   [out,in,c]=string(fun)
45   if size(in,'*')<>3 then
46     messagebox(_("The selected function must have 3 input parameters (curve,pt,index)"))
47     return
48   end
49   if size(out,'*')<>1 then
50     messagebox(_("The selected function must have 1 output parameter (str)"))
51     return
52   end
53   ok=%t
54 endfunction