Avoid overloading of a Windows API function making compilation fail under Windows
[scilab.git] / scilab / modules / scicos_blocks / includes / scoSetProperty.h
1 /*  Scicos
2 *
3 *  Copyright (C) INRIA - METALAU Project <scicos@inria.fr>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 *
19 * See the file ./license.txt
20 */
21 /**
22 \file scoSetProperty.h
23 \author Benoit Bayol
24 \version 1.0
25 \date September 2006 - January 2007
26 \brief Header file of the scoSetProperty.c file
27 */
28
29 #ifndef __SCO_SET_PROPERTY_H__
30 #define __SCO_SET_PROPERTY_H__
31
32 #include "dynlib_scicos_blocks.h"
33 #include "scoBase.h"
34
35 /**
36 \brief Set value in the hScopeWindow
37 \param pScopeMemory a pointer on a ScopeMemory
38 \param value the new value of the handle
39 */
40 SCICOS_BLOCKS_IMPEXP void scoSetHandleScopeWindow(ScopeMemory * pScopeMemory, long value);
41
42 /**
43 \brief Set value in the hAxes
44 \param pScopeMemory a pointer on a ScopeMemory
45 \param i index of an axes
46 \param value the new value of the handle hAxes[i]
47 */
48 SCICOS_BLOCKS_IMPEXP void scoSetHandleAxes(ScopeMemory * pScopeMemory, int i, long value);
49
50 /**
51 \brief Set value in the hShortDraw[i][j] 
52 \param pScopeMemory a pointer on a ScopeMemory
53 \param i index of an axes
54 \param j index of a curve
55 \param value the new value of the hShortDraw[i][j]
56 */
57 SCICOS_BLOCKS_IMPEXP void scoSetHandleShortDraw(ScopeMemory * pScopeMemory, int i,int j, long value);
58
59 /**
60 \brief Set value in the hLongDraw[i][j]
61 \param pScopeMemory a pointer on a ScopeMemory
62 \param i index of an axes
63 \param j index of a curve
64 \param value the new value of the hLongDraw[i][j]
65 */ 
66 SCICOS_BLOCKS_IMPEXP void scoSetHandleLongDraw(ScopeMemory * pScopeMemory, int i,int j, long value);
67
68 /**
69 \brief Set value in the new_draw[i]
70 \param pScopeMemory a pointer on a ScopeMemory
71 \param i index of an axes
72 \param value the new value of new_draw[i]
73 */
74 SCICOS_BLOCKS_IMPEXP void scoSetNewDraw(ScopeMemory * pScopeMemory, int i, int value);
75
76 /**
77 \brief Set value in the period_counter[i]
78 \param pScopeMemory a pointer on a ScopeMemory
79 \param i index of an axes
80 \param value the new value of period_counter[i]
81 */
82 SCICOS_BLOCKS_IMPEXP void scoSetPeriodCounter(ScopeMemory * pScopeMemory, int i, int value);
83
84 /**
85 \brief Set value in the trace_length[i]
86 \param pScopeMemory a pointer on a ScopeMemory
87 \param i index of an axes
88 \param value the new value of trace_length[i]
89 */
90 SCICOS_BLOCKS_IMPEXP void scoSetLongDrawSize(ScopeMemory * pScopeMemory, int i, int value);
91
92 /**
93 \brief Set value in the number_of_subwin
94 \param pScopeMemory a pointer on a ScopeMemory
95 \param value the new value of number_of_subwin
96
97 */
98 SCICOS_BLOCKS_IMPEXP void scoSetNumberOfSubwin(ScopeMemory * pScopeMemory, int value);
99
100 /**
101 \brief Set value in the number_of_curves_by_subwin[i]
102 \param pScopeMemory a pointer on a ScopeMemory
103 \param i index of an axes
104 \param value the new value of number_of_curves_by_subwin[i]
105 */ 
106 SCICOS_BLOCKS_IMPEXP void scoSetNumberOfCurvesBySubwin(ScopeMemory * pScopeMemory, int i, int value);
107
108 /**
109 \brief Set value in the win_id
110 \param pScopeMemory a pointer on a ScopeMemory
111 \param value the new value of the win_id
112 */
113 SCICOS_BLOCKS_IMPEXP void scoSetWindowID(ScopeMemory * pScopeMemory, int value);
114
115 /**
116 \brief Set value in the buffer_size[i]
117 \param pScopeMemory a pointer on a ScopeMemory
118 \param i index of an axes
119 \param value the new value of buffer_size[i]
120 */
121 SCICOS_BLOCKS_IMPEXP void scoSetShortDrawSize(ScopeMemory * pScopeMemory, int i, int value);
122
123 /**
124 \brief Set value in the period[i]
125 \param pScopeMemory a pointer on a ScopeMemory
126 \param i index of an axes
127 \param value the new value of period[i]
128 */
129 SCICOS_BLOCKS_IMPEXP void scoSetPeriod(ScopeMemory * pScopeMemory, int i, double value);
130
131 /**
132 \brief Set value of handle axes in the structure by passing a pointer on argument
133 \param pScopeMemory a pointer on a ScopeMemory
134 \param i the position i of the axes
135 \param value a scoGraphicalObject (i.e. sciPointObj *) of an axes
136 */
137 SCICOS_BLOCKS_IMPEXP void scoSetHandleFromPointerAxes(ScopeMemory * pScopeMemory, int i, scoGraphicalObject value);
138
139 /**
140 \brief Set value of handle shortdraw in the structure by passing a pointer on argument
141 \param pScopeMemory a pointer on a ScopeMemory
142 \param i the position i of the axes
143 \param j the position j of the shortdraw in the axes
144 \param value a scoGraphicalObject (i.e. sciPointObj *) of a shortdraw
145 */
146 SCICOS_BLOCKS_IMPEXP void scoSetHandleFromPointerShortDraw(ScopeMemory * pScopeMemory, int i,int j, scoGraphicalObject value);
147
148 /**
149 \brief Set value of handle longdraw in the structure by passing a pointer on argument
150 \param pScopeMemory a pointer on a ScopeMemory
151 \param i the position i of the axes
152 \param j the position j of the longdraw in the axes
153 \param value a scoGraphicalObject (i.e. sciPointObj *) of a longdraw
154 */
155 SCICOS_BLOCKS_IMPEXP void scoSetHandleFromPointerLongDraw(ScopeMemory * pScopeMemory, int i,int j, scoGraphicalObject value);
156
157 /**
158 \brief Set value of handle scopewindow in the structure by passing a pointer on argument
159 \param pScopeMemory a pointer on a ScopeMemory
160 \param value a scoGraphicalObject (i.e. sciPointObj *) of a window
161 */
162 SCICOS_BLOCKS_IMPEXP void scoSetHandleFromPointerScopeWindow(ScopeMemory * pScopeMemory, scoGraphicalObject value);
163
164
165 /**
166 \brief Set value for activation (1 activate 0 else (by default))
167 \param pScopeMemory a pointer on a ScopeMemory
168 \param status : 1 activate 0 deactivate
169 */
170 SCICOS_BLOCKS_IMPEXP void scoSetScopeActivation(ScopeMemory * pScopeMemory, int status);
171
172
173 #endif