5ba17cc307e4878374aa4335bc025e08e6f0cfbd
[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  * 
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at    
9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10  *
11  */
12
13 /*======================================================================================*/
14 /* Copyrigth INRIA 2006                                                                 */
15 /* Desc   : Various functions to manipulate SubWindow objects                           */
16 /*======================================================================================*/
17
18 #ifndef __SCI_AXES_H__
19 #define __SCI_AXES_H__
20
21 #include "dynlib_graphics.h"
22 #include "ObjectStructure.h"
23
24
25 /*-----------------------------------------------------------------------------*/
26
27 /* clear a subwindow from all of its children */
28 GRAPHICS_IMPEXP void clearSubWin( sciPointObj * pSubWin ) ;
29
30 /* reinit a subwindow (but don't change position) */
31 GRAPHICS_IMPEXP void reinitSubWin( sciPointObj * pSubWin ) ;
32
33 /* reinit the viewing angles of a subwindow */
34 GRAPHICS_IMPEXP void initSubWinAngles( sciPointObj * pSubWin ) ;
35
36 /* set the size and position of the subwindow to the default */
37 GRAPHICS_IMPEXP void initSubWinSize( sciPointObj * pSubWin ) ;
38
39 /* set the data_bounds of the axes to the default value */
40 GRAPHICS_IMPEXP void initSubWinBounds( sciPointObj * pSubWin ) ;
41
42 /* reinit the selected subwindow if the auto_clear property is set to on */
43 /* return TRUE if the window has been redrawn */
44 GRAPHICS_IMPEXP BOOL checkRedrawing( void ) ;
45
46 /**
47  * Find which subwindow is selected by clincking at pixel coordinates (xCoord, yCoord).
48  * @param pFigure index of parent figure in which the subwindow will be selected
49  * @return NULL if no subwindow could be selected, the seleceted subwindow otherwise
50  */
51 GRAPHICS_IMPEXP sciPointObj * getClickedSubwin(sciPointObj * pFigure, int xCoord, int yCoord);
52
53 /**
54  * Convert property name into a sciLegendPlace
55  */
56 GRAPHICS_IMPEXP sciLegendPlace propertyNameToLegendPlace(const char * string);
57
58 /*-----------------------------------------------------------------------------*/
59 #endif /*__SCI_AXES_H_*/