1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2011-2011 - DIGITEO - Bruno JOFRET
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  */
15 
16 #ifndef __FIGURE_LIST_H__
17 #define __FIGURE_LIST_H__
18 
19 #include "dynlib_graphic_objects.h"
20 #include "BOOL.h"
21 
22 /**
23  * @return number of opened windows in Scilab.
24  */
25 GRAPHIC_OBJECTS_IMPEXP int sciGetNbFigure(void);
26 
27 /**
28  * @return the next free figure id.
29  */
30 GRAPHIC_OBJECTS_IMPEXP int getValidDefaultFigureId();
31 
32 /**
33  * Fill the array Ids with all the figure ids currently used by Scilab.
34  * @param ids should be as long as there are figures.
35  */
36 GRAPHIC_OBJECTS_IMPEXP void sciGetFiguresId(int ids[]);
37 
38 /**
39  * @return TRUE if the figure with index id exists
40  */
41 GRAPHIC_OBJECTS_IMPEXP BOOL sciIsExistingFigure(int figNum);
42 
43 /**
44  * Register Scilab View to Graphic Controller
45  */
46 GRAPHIC_OBJECTS_IMPEXP void registerToController(void);
47 
48 /**
49  * Unregister Scilab View to Graphic Controller
50  */
51 GRAPHIC_OBJECTS_IMPEXP void unregisterToController(void);
52 
53 /**
54  * to know if there are some opened graphic windows
55  */
56 GRAPHIC_OBJECTS_IMPEXP BOOL sciHasFigures(void);
57 
58 /**
59  * returns the UID of window i
60  * or NULL if this window does not exist
61  */
62 GRAPHIC_OBJECTS_IMPEXP int getFigureFromIndex(int figNum);
63 
64 GRAPHIC_OBJECTS_IMPEXP int search_path(char* _pstPath);
65 GRAPHIC_OBJECTS_IMPEXP char* get_path(int uid);
66 
67 
68 #endif /* !__FIGURE_LIST_H__ */
69