98ce635a9d9b1a7ddf995c03392b10a23cd9dcfb
[scilab.git] / scilab / modules / renderer / includes / SetJavaProperty.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007 - INRIA - Jean-Baptiste Silvy 
4  * desc : Interface functions between between SetProperty functions and
5  * the C++/Java part of module
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  */
14
15 #ifndef _SET_JAVA_PROPERTY_H_
16 #define _SET_JAVA_PROPERTY_H_
17
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21
22 #include "ObjectStructure.h"
23
24 /**
25  * Change the colormap of a figure. The colormap is stored in java
26  * so we need to access it.
27  * @param pFigure the figure we wants to modify
28  * @param rgbMat matrix of size nbColor x 3 conating the 3 channels
29  *               RGB of each color.
30  * @param nbColor number of color in the new colormap
31  */
32 void sciSetJavaColormap( sciPointObj * pFigure, const double rgbMat[], int nbColor ) ;
33
34 /**
35  * Set the size of a figure object
36  */
37 void sciSetJavaFigureSize( sciPointObj * pFigure, const int size[2] ) ;
38
39 /**
40  * Set the size of a window enclosing a figure.
41  */
42 void sciSetJavaWindowSize( sciPointObj * pFigure, const int size[2] ) ;
43
44 /**
45  * Set the position in pixels of a window enclosing a figure.
46  */
47 void sciSetJavaWindowPosition( sciPointObj * pFigure, const int pos[2] ) ;
48
49 /**
50  * Set the message displayed by a figure.
51  */
52 void sciSetJavaInfoMessage( sciPointObj * pFigure, const char * infoMessage ) ;
53
54 /**
55  * Set the pixmap mode for figures.
56  */
57 void sciSetJavaPixmapMode(sciPointObj * pFigure, BOOL onOrOff);
58
59 /**
60  * Specify if the figure can be renderered now
61  */
62 void sciSetJavaRenderingEnable(sciPointObj * pFigure, BOOL isEnable);
63
64 /**
65  * Zoom a subwin object with the specified rectangle in pixels
66  */
67 void sciJavaZoomRect(sciPointObj * pSubwin, int posX, int posY, int width, int height);
68
69 /**
70  * Set the auto_resize mode of a figure
71  */
72 void sciSetJavaAutoResizeMode(sciPointObj * pFigure, BOOL resizeMode);
73
74 /**
75  * Set the position and size of the viewport on the canvas
76  * @param viewport [x,y,w,h] array
77  */
78 void sciSetJavaViewport(sciPointObj * pFigure, const int viewport[4]);
79
80 /**
81  * Set the background color of canvas
82  */
83 void sciSetJavaBackground(sciPointObj * pFigure, int backColor);
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif /* _SET_JAVA_PROPERTY_H_ */