Current Axes clear reinitSubWin and related C functions adapted to the MVC:
[scilab.git] / scilab / modules / graphics / includes / Axes.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2006 - INRIA - Jean-Baptiste Silvy
4  * Copyright (C) 2010-2012 - DIGITEO - Manuel Juliachs
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  */
13
14 /*======================================================================================*/
15 /* Copyrigth INRIA 2006                                                                 */
16 /* Desc   : Various functions to manipulate SubWindow objects                           */
17 /*======================================================================================*/
18
19 #ifndef __SCI_AXES_H__
20 #define __SCI_AXES_H__
21
22 #include "dynlib_graphics.h"
23 #include "ObjectStructure.h"
24
25
26 /*-----------------------------------------------------------------------------*/
27
28 /* clear a subwindow from all of its children */
29 GRAPHICS_IMPEXP void clearSubWin(char * pSubWinUID);
30
31 /* reinit a subwindow (but don't change position) */
32 GRAPHICS_IMPEXP void reinitSubWin(char * pSubWinUID);
33
34 /* reinit the viewing angles of a subwindow */
35 GRAPHICS_IMPEXP void initSubWinAngles(char * pSubWinUID);
36
37 /* set the size and position of the subwindow to the default */
38 GRAPHICS_IMPEXP void initSubWinSize( sciPointObj * pSubWin );
39
40 /* set the data_bounds of the axes to the default value */
41 GRAPHICS_IMPEXP void initSubWinBounds(char * pSubWinUID);
42
43 /* reinit the selected subwindow if the auto_clear property is set to on */
44 /* return TRUE if the window has been redrawn */
45 GRAPHICS_IMPEXP BOOL checkRedrawing(void);
46
47 /**
48  * Find which subwindow is selected by clincking at pixel coordinates (xCoord, yCoord).
49  * @param pFigure index of parent figure in which the subwindow will be selected
50  * @return NULL if no subwindow could be selected, the seleceted subwindow otherwise
51  */
52 GRAPHICS_IMPEXP sciPointObj * getClickedSubwin(sciPointObj * pFigure, int xCoord, int yCoord);
53
54 /**
55  * Convert property name into a sciLegendPlace
56  */
57 GRAPHICS_IMPEXP sciLegendPlace propertyNameToLegendPlace(const char * string);
58
59 /*
60  * Converts a boolean log flag to the character format
61  */
62 GRAPHICS_IMPEXP char getTextLogFlag(int logFlag);
63
64 /*
65  * Converts a character log flag to the equivalent boolean
66  */
67 GRAPHICS_IMPEXP int getBooleanLogFlag(char logFlag);
68
69 /*-----------------------------------------------------------------------------*/
70 #endif /*__SCI_AXES_H_*/