92efbb7eaf9f7017e5de33496f6392a8c09a5cec
[scilab.git] / scilab / modules / graphics / includes / GetProperty.h
1 /*------------------------------------------------------------------------
2  *    Graphic library 
3  *    Copyright INRIA
4  *    newGraph Library header
5  *    Matthieu PHILIPPE,   INRIA 2001-2002
6  *    Djalel ABDEMOUCHE,   INRIA 2002-2004
7  *    Fabrice Leray,       INRIA 2004-2006
8  *    Jean-Baptiste Silvy, INRIA 2005-xxxx
9  *    Comment:
10  *    This file contains all functions used to GET the properties of graphics
11  *    objects.
12  --------------------------------------------------------------------------*/
13
14
15
16 #ifndef __SCI_GET_PROPERTY__
17 #define __SCI_GET_PROPERTY__
18
19
20
21 #include "ObjectStructure.h"
22 #include "HandleManagement.h"
23 #include "StringMatrix.h"
24 #include "bcg.h"
25
26 void *sciGetPointerToFeature (sciPointObj * pobj); /* GET */
27 void sciGetPointerToUserData (sciPointObj * pobj,int ***user_data_ptr, int **size_ptr); /* GET */
28 sciEntityType sciGetEntityType (sciPointObj * pobj);  /* GET */
29 char *sciGetCharEntityType (sciPointObj * pobj);  /* GET */
30
31 /* Graphic Context Functions */
32 sciGraphicContext *sciGetGraphicContext (sciPointObj * pobj); /* GET */
33 int sciGetNumColors (sciPointObj * pobj); /* GET */
34 int sciGetColormap (sciPointObj * pobj, double rgbmat[] ); /* GET */
35 int sciGetNumColors( sciPointObj * pobj ) ; /* GET */
36 int sciGetGoodIndex(sciPointObj * pobj, int colorindex);  /* GET */
37
38 int sciGetForegroundToDisplay (sciPointObj * pobj); /* GET */
39 int sciGetBackgroundToDisplay (sciPointObj * pobj); /* GET */
40
41 int sciGetBackground (sciPointObj * pobj); /* GET */
42 int sciGetForeground (sciPointObj * pobj); /* GET */
43 int sciGetLineWidth (sciPointObj * pobj); /* GET */
44 BOOL sciGetIsLine (sciPointObj * pobj); /* GET */
45 int sciGetLineStyle (sciPointObj * pobj); /* GET */
46 BOOL sciGetIsMark (sciPointObj * pobj); /* GET */
47 BOOL sciGetIsFilled (sciPointObj * pobj); /* GET */
48 EAxesBoxType sciGetBoxType( sciPointObj * pobj ) ; /* GET */
49 BOOL sciGetIsBoxed (sciPointObj * pobj); /* GET */
50 int sciGetMarkStyle (sciPointObj * pobj); /* GET */
51 int sciGetMarkSize (sciPointObj * pobj); /* GET */
52 int sciGetMarkSizeUnit (sciPointObj * pobj); /* GET */
53 int sciGetFillStyle (sciPointObj * pobj); /* GET */
54
55 /* Text Functions */
56 sciFont *sciGetFontContext (sciPointObj * pobj);  /* GET */
57 int sciGetFontDeciWidth (sciPointObj * pobj); /* GET */
58 int sciGetFontOrientation (sciPointObj * pobj); /* GET */
59 StringMatrix * sciGetText (sciPointObj * pobj); /* GET */
60 void sciGetTextSize( sciPointObj * pobj, int * nbRow, int * nbCol ) ; /* GET */
61 unsigned int sciGetTextLength (sciPointObj * pobj); /* GET */
62
63 int sciGetFontBackground (sciPointObj * pobj); /* GET */
64 int sciGetFontForeground (sciPointObj * pobj); /* GET */
65 int sciGetMarkBackground (sciPointObj * pobj); /* GET */
66 int sciGetMarkForeground (sciPointObj * pobj); /* GET */
67 /* F.Leray 09.04.04*/
68 int sciGetFontBackgroundToDisplay (sciPointObj * pobj); /* GET */
69 int sciGetFontForegroundToDisplay (sciPointObj * pobj); /* GET */
70 int sciGetMarkBackgroundToDisplay (sciPointObj * pobj); /* GET */
71 int sciGetMarkForegroundToDisplay (sciPointObj * pobj); /* GET */
72
73 int sciGetFontStyle (sciPointObj * pobj); /* GET */
74 char *sciGetFontName (sciPointObj * pobj); /* GET */
75 unsigned int sciGetFontNameLength (sciPointObj * pobj); /* GET */
76 double sciGetTextPosX (sciPointObj * pobj); /* GET */
77 double sciGetTextPosY (sciPointObj * pobj); /* GET */
78 double sciGetTextPosWidth (sciPointObj * pobj); /* GET */
79 double sciGetTextPosHeight (sciPointObj * pobj); /* GET */
80
81 /*Title Functions */
82 POINT2D sciGetTitlePos (sciPointObj * pobj); /* GET */
83 sciTitlePlace sciGetTitlePlace (sciPointObj * pobj); /* GET */
84
85 /* Legend */
86 sciLegendPlace sciGetLegendPlace (sciPointObj * pobj);
87 POINT2D sciGetLegendPos (sciPointObj * pobj);
88
89 /* Figure / Subwin main functions */
90 sciPointObj *sciGetParentFigure (sciPointObj * pobj); /* GET */
91 sciPointObj *sciGetParentSubwin (sciPointObj * pobj); /* GET */
92 int sciGetNumFigure (sciPointObj * pobj); /* GET */
93 struct BCG *sciGetScilabXgc (sciPointObj * pobj); /* GET */
94
95 /* GMODE */
96 scigMode *sciGetGraphicMode (sciPointObj * pobj);  /* GET */
97 int sciGetIsClipRegionValuated (sciPointObj * pobj);
98 int sciGetIsClipping (sciPointObj * pobj); /* GET */
99 double *sciGetClipping (sciPointObj * pobj); /* GET */
100 BOOL sciGetHighLight (sciPointObj * pobj);  /* GET */
101 BOOL sciGetAddPlot (sciPointObj * pobj);  /* GET */
102 BOOL sciGetAutoScale (sciPointObj * pobj);  /* GET */
103 BOOL sciGetZooming (sciPointObj * pobj);  /* GET */
104 int sciGetXorMode (sciPointObj * pobj);  /* GET */
105 BOOL sciGetRealVisibility (sciPointObj * pobj) ; /* GET */
106 BOOL sciGetVisibility (sciPointObj * pobj);  /* GET */
107 BOOL sciGetResize (sciPointObj * pobj);  /* GET */
108
109
110 /* Window Functions */
111 char *sciGetName (sciPointObj * pobj);  /* GET */
112 int sciGetNameLength (sciPointObj * pobj);  /* GET */
113 int sciGetNum (sciPointObj * pobj);  /* GET */
114 int sciGetWidth (sciPointObj * pobj);   /* GET */
115 int sciGetHeight (sciPointObj * pobj);  /* GET */
116 void sciGetDim( sciPointObj * pobj, int * pWidth, int * pHeight ) ; /* GET */
117 int sciGetWindowWidth(sciPointObj * pObj) ; /* GET */
118 int sciGetWindowHeight(sciPointObj * pObj) ; /* GET */
119 BOOL sciGetIsFigureIconified (sciPointObj * pobj);  /* GET */
120 int sciGetSubwindowPosX (sciPointObj * pobj);  /* GET */
121 int sciGetSubwindowPosY (sciPointObj * pobj);  /* GET */
122 sciPointObj *sciIsExistingSubWin (double *WRect); /* GET */ /* WARNING special case here */
123 sciPointObj *sciIsExistingFigure(int *value); /* GET */ /* WARNING special case here */
124 int sciGetScrollPosV (sciPointObj * pobj);  /* GET */
125 int sciGetScrollPosH (sciPointObj * pobj);  /* GET */
126
127 sciPointObj * sciGetCurPointedFigure( void ) ; /* GET */
128 BOOL sciGetReplay (void); /* GET */
129
130
131 double *sciGetPoint (sciPointObj * pthis, int *num, int *numco); /* GET */
132 sciPointObj *sciGetObjClicked (sciPointObj *pthis,int x, int y); /* GET */ /* unused */
133 BOOL sciIsClicked(sciPointObj *pthis,int x, int y);  /* GET */
134
135 BOOL sciGetdrawmode (sciPointObj *pobj); /* GET */
136 sciPointObj *sciGetAxes (sciPointObj *pparentfigure,sciPointObj *psubwin); /* GET */
137
138
139 int sciType (char *marker, sciPointObj *pobj); /* GET */
140
141 int  sciGetNbFigure( void ) ; /* GET */
142 void sciGetFiguresId( int figIds[] ) ; /* GET */
143 void sciGetIdFigure (int *vect, int *id, int *flag); /* GET */
144 unsigned int sciGetFontNameLength (sciPointObj * pobj); /* GET */
145 /* struct BCG *sciGetCurrentScilabXgc (); /\* GET *\/ */
146
147 sciPointObj *sciGetSurface(sciPointObj *psubwin); /* GET */
148
149 sciPointObj *CheckClickedSubwin(integer x, integer y); /* GET */
150
151 /* BOOL GetIsAxes(sciPointObj *psubwin); /\* GET *\/ */
152 BOOL GetIsAxes2D(sciPointObj *psubwin); /* GET */
153
154 int CheckForCompound (long *tabpointobj, int number); /* GET */
155
156 /* UNUSED ? */
157 sciPointObj *sciGetOriginalSubWin (sciPointObj * pfigure);
158 HMENU sciGethPopMenu (sciPointObj * pthis);
159
160 int *sciGetInterpVector(sciPointObj * pobj);
161 int sciGetPosition (sciPointObj * pobj, double *x, double *y);
162
163 BOOL sciGetAutoRotation ( sciPointObj * pObj ) ;
164 BOOL sciGetAutoPosition ( sciPointObj * pObj ) ;
165
166 BOOL sciGetCenterPos( sciPointObj * pObj ) ;
167
168 BOOL sciGetIs3d( sciPointObj * pObj ) ;
169
170 /**
171  * for a subwindow object, return if the its labels (x,y,z) are all
172  *       empty or not.
173  * @param pObj the subwindow.
174  */
175 BOOL sciGetLegendDefined( sciPointObj * pObj ) ;
176
177 BOOL sciGetAutoSize( sciPointObj * pObj ) ;
178 sciTextAlignment sciGetAlignment( sciPointObj * pObj ) ;
179 void sciGetUserSize( sciPointObj * pObj, double * width, double * height ) ;
180
181 int sciGetNbChildren( sciPointObj * pObj ) ; /* GET */
182
183 BOOL sciGetIsAccessibleChild( sciPointObj * pObj ) ; /* GET */
184
185 int sciGetNbAccessibleChildren( sciPointObj * pObj ) ; /* GET */
186
187 BOOL GetHandleVisibilityOnUimenu( sciPointObj * pobj ) ; /* GET */
188
189 int sciGetNbTypedObjects( sciPointObj * pObj, sciEntityType type ) ;
190
191 int sciGetHiddenColor( sciPointObj * pObj ) ;
192
193 BOOL sciGetIsAutoDrawable( sciPointObj * pobj ) ;
194
195 void sciGetGridStyle( sciPointObj * pObj, int * xStyle, int * yStyle, int * zStyle ) ;
196
197 void sciGetViewport( sciPointObj * pObj, int * xSize, int * ySize ) ;
198
199 char * sciGetInfoMessage( sciPointObj * pObj ) ;
200
201 int sciGetInfoMessageLength( sciPointObj * pObj ) ;
202
203 void sciGetScreenPosition( sciPointObj * pObj, int * posX, int * posY ) ;
204
205 BOOL sciGetIsEventHandlerEnable( sciPointObj * pObj ) ;
206 char * sciGetEventHandler( sciPointObj * pObj ) ;
207
208 double * sciGetAxesBounds( sciPointObj * pObj ) ;
209 double * sciGetMargins( sciPointObj * pObj ) ;
210
211 BOOL sciGetIsReadyForRendering( sciPointObj * pobj ) ; /* GET */
212
213 #endif /* __SCI_GET_PROPERTY__ */