\hypertarget{template_8cpp}{ \section{sources/template.cpp File Reference} \label{template_8cpp}\index{sources/template.cpp@{sources/template.cpp}} } {\ttfamily \#include $<$scol.h$>$}\par {\ttfamily \#include \char`\"{}Bloc.h\char`\"{}}\par \subsection*{Defines} \begin{DoxyCompactItemize} \item \#define \hyperlink{template_8cpp_a075ae031cb0ae4674cb7bf85e035d7af}{NbTplPKG}~8 \begin{DoxyCompactList}\small\item\em Nb of Scol functions or types. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Typedefs} \begin{DoxyCompactItemize} \item typedef int \hyperlink{group__group1_ga85711c057e7ad8f65fd0190fc0639f87}{BlocObj} \begin{DoxyCompactList}\small\item\em Scol \hyperlink{class_bloc}{Bloc} Object It allows simple operations like getting and setting its attributes. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Functions} \begin{DoxyCompactItemize} \item int \hyperlink{group__group1_gae801504f1f746026f0386ae5705e9008}{\_\-GETblocValue} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-GETblocValue : Get the value of the \hyperlink{class_bloc}{Bloc} object \item\end{DoxyCompactList}\item int \hyperlink{group__group1_ga72cef6cbca74b4ce6715a387f811e834}{\_\-SETblocValue} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-SETblocValue : Set the value of the bloc \item\end{DoxyCompactList}\item int \hyperlink{group__group1_ga1eed6bf98129fdd265b5f07ab4743e2a}{\_\-GETblocName} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-GETblocName : Get the name of the bloc \item\end{DoxyCompactList}\item int \hyperlink{group__group1_gacae00870405f8f406fab2ea9c115c142}{\_\-SETblocName} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-SETblocName : Set the name of the bloc \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_afd50d63db35adcc32d8c244cfa816809}{destroyBlocObj} (mmachine m, int handsys, int blocTab) \begin{DoxyCompactList}\small\item\em Scol object destroy callback. \item\end{DoxyCompactList}\item int \hyperlink{group__group1_gafe341a6e862309b65cad704011d2824e}{\_\-CRbloc} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-CRbloc : Open, initialize \hyperlink{class_bloc}{Bloc} object \item\end{DoxyCompactList}\item int \hyperlink{group__group1_gaaad556e6b2a980ee77045edc80b99ee8}{\_\-DSbloc} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-DSbloc : Destroy bloc object \item\end{DoxyCompactList}\item int \hyperlink{group__group1_ga00f6dd2878cb03643e937c6eb91bda17}{\_\-CBblocChangeValue} (mmachine m) \begin{DoxyCompactList}\small\item\em \_\-CBblocChangeValue : This function sets the callback to be executed when \hyperlink{class_bloc}{Bloc} value change event happens \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_a8bcbc4b33d58b8ab59cd5f66df4b3dac}{getBlocNewData} (mmachine m, HWND h, unsigned msg, UINT id, LONG param, int $\ast$ret) \begin{DoxyCompactList}\small\item\em sample function for calling scol reflex defined for BLOC\_\-NEW\_\-DATA\_\-CB \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_a81da99c4ce47abf8b7a6e9cf7f9d5bf7}{LoadBloc} (mmachine m) \begin{DoxyCompactList}\small\item\em Load the \hyperlink{class_bloc}{Bloc}. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Variables} \begin{DoxyCompactItemize} \item HWND \hyperlink{template_8cpp_ac55ff10fe408688aa0ee11bd0cc655df}{HScol} = NULL \item cbmachine \hyperlink{template_8cpp_a95981606817c56a4a3aa27218ae6e722}{ww} \begin{DoxyCompactList}\small\item\em Scol machine declaration for MM macros. \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_a14568e247a197341165585b7a2f28380}{OBJBLOCSCOL} \begin{DoxyCompactList}\small\item\em \hyperlink{class_bloc}{Bloc} Object in Scol. \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_a9aa1a9b27a3730bfbcc75f6407ec69eb}{SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB} = 0 \begin{DoxyCompactList}\small\item\em New data event callback number. \item\end{DoxyCompactList}\item int \hyperlink{template_8cpp_a0d4339d69574973295d790e5e77740f9}{BLOC\_\-NEW\_\-DATA\_\-CB} \begin{DoxyCompactList}\small\item\em New data event number. \item\end{DoxyCompactList}\item char $\ast$ \hyperlink{template_8cpp_a9fb82289ed02d14c4137bc91c0128e33}{TplName} \mbox{[}NbTplPKG\mbox{]} \item int($\ast$ \hyperlink{template_8cpp_a95c0009400a7f8a271a9f8f84b7a0e4c}{TplFunc} \mbox{[}NbTplPKG\mbox{]})(mmachine m) \item int \hyperlink{template_8cpp_a7f359b36c24b953bd273ccd63711234b}{TplNArg} \mbox{[}NbTplPKG\mbox{]} \item char $\ast$ \hyperlink{template_8cpp_a3101c86c8a5f2e825fca960e3b4bf447}{TplType} \mbox{[}NbTplPKG\mbox{]} \end{DoxyCompactItemize} \subsection{Define Documentation} \hypertarget{template_8cpp_a075ae031cb0ae4674cb7bf85e035d7af}{ \index{template.cpp@{template.cpp}!NbTplPKG@{NbTplPKG}} \index{NbTplPKG@{NbTplPKG}!template.cpp@{template.cpp}} \subsubsection[{NbTplPKG}]{\setlength{\rightskip}{0pt plus 5cm}\#define NbTplPKG~8}} \label{template_8cpp_a075ae031cb0ae4674cb7bf85e035d7af} Nb of Scol functions or types. Definition at line 396 of file template.cpp. \subsection{Function Documentation} \hypertarget{template_8cpp_afd50d63db35adcc32d8c244cfa816809}{ \index{template.cpp@{template.cpp}!destroyBlocObj@{destroyBlocObj}} \index{destroyBlocObj@{destroyBlocObj}!template.cpp@{template.cpp}} \subsubsection[{destroyBlocObj}]{\setlength{\rightskip}{0pt plus 5cm}int destroyBlocObj (mmachine {\em m}, \/ int {\em handsys}, \/ int {\em blocTab})}} \label{template_8cpp_afd50d63db35adcc32d8c244cfa816809} Scol object destroy callback. \begin{DoxyParams}{Parameters} \item[{\em mmachine}]: scol machine structure \item[{\em int}]: scol object system handle \item[{\em int}]: scol object stack handle\end{DoxyParams} \begin{DoxyReturn}{Returns} int : 0 \end{DoxyReturn} Definition at line 225 of file template.cpp. \hypertarget{template_8cpp_a8bcbc4b33d58b8ab59cd5f66df4b3dac}{ \index{template.cpp@{template.cpp}!getBlocNewData@{getBlocNewData}} \index{getBlocNewData@{getBlocNewData}!template.cpp@{template.cpp}} \subsubsection[{getBlocNewData}]{\setlength{\rightskip}{0pt plus 5cm}int getBlocNewData (mmachine {\em m}, \/ HWND {\em h}, \/ unsigned {\em msg}, \/ UINT {\em id}, \/ LONG {\em param}, \/ int $\ast$ {\em ret})}} \label{template_8cpp_a8bcbc4b33d58b8ab59cd5f66df4b3dac} sample function for calling scol reflex defined for BLOC\_\-NEW\_\-DATA\_\-CB \begin{DoxyParams}{Parameters} \item[{\em mmachine}]: scol machine structure \item[{\em HWND}]: target window handle \item[{\em unsigned}]msg : window message \item[{\em UINT}]: callback param \item[{\em LONG}]: callback param \item[{\em int}]: return value \end{DoxyParams} Definition at line 371 of file template.cpp. \hypertarget{template_8cpp_a81da99c4ce47abf8b7a6e9cf7f9d5bf7}{ \index{template.cpp@{template.cpp}!LoadBloc@{LoadBloc}} \index{LoadBloc@{LoadBloc}!template.cpp@{template.cpp}} \subsubsection[{LoadBloc}]{\setlength{\rightskip}{0pt plus 5cm}int LoadBloc (mmachine {\em m})}} \label{template_8cpp_a81da99c4ce47abf8b7a6e9cf7f9d5bf7} Load the \hyperlink{class_bloc}{Bloc}. \begin{DoxyParams}{Parameters} \item[{\em mmachine}]: scol machine structure\end{DoxyParams} \begin{DoxyReturn}{Returns} int : 0 if succes, error code otherwise \end{DoxyReturn} Definition at line 470 of file template.cpp. \subsection{Variable Documentation} \hypertarget{template_8cpp_a0d4339d69574973295d790e5e77740f9}{ \index{template.cpp@{template.cpp}!BLOC\_\-NEW\_\-DATA\_\-CB@{BLOC\_\-NEW\_\-DATA\_\-CB}} \index{BLOC\_\-NEW\_\-DATA\_\-CB@{BLOC\_\-NEW\_\-DATA\_\-CB}!template.cpp@{template.cpp}} \subsubsection[{BLOC\_\-NEW\_\-DATA\_\-CB}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf BLOC\_\-NEW\_\-DATA\_\-CB}}} \label{template_8cpp_a0d4339d69574973295d790e5e77740f9} New data event number. Definition at line 51 of file template.cpp. \hypertarget{template_8cpp_ac55ff10fe408688aa0ee11bd0cc655df}{ \index{template.cpp@{template.cpp}!HScol@{HScol}} \index{HScol@{HScol}!template.cpp@{template.cpp}} \subsubsection[{HScol}]{\setlength{\rightskip}{0pt plus 5cm}HWND {\bf HScol} = NULL}} \label{template_8cpp_ac55ff10fe408688aa0ee11bd0cc655df} Definition at line 39 of file template.cpp. \hypertarget{template_8cpp_a14568e247a197341165585b7a2f28380}{ \index{template.cpp@{template.cpp}!OBJBLOCSCOL@{OBJBLOCSCOL}} \index{OBJBLOCSCOL@{OBJBLOCSCOL}!template.cpp@{template.cpp}} \subsubsection[{OBJBLOCSCOL}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf OBJBLOCSCOL}}} \label{template_8cpp_a14568e247a197341165585b7a2f28380} \hyperlink{class_bloc}{Bloc} Object in Scol. Definition at line 45 of file template.cpp. \hypertarget{template_8cpp_a9aa1a9b27a3730bfbcc75f6407ec69eb}{ \index{template.cpp@{template.cpp}!SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB@{SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB}} \index{SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB@{SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB}!template.cpp@{template.cpp}} \subsubsection[{SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf SCOL\_\-BLOC\_\-NEW\_\-DATA\_\-CB} = 0}} \label{template_8cpp_a9aa1a9b27a3730bfbcc75f6407ec69eb} New data event callback number. Definition at line 48 of file template.cpp. \hypertarget{template_8cpp_a95c0009400a7f8a271a9f8f84b7a0e4c}{ \index{template.cpp@{template.cpp}!TplFunc@{TplFunc}} \index{TplFunc@{TplFunc}!template.cpp@{template.cpp}} \subsubsection[{TplFunc}]{\setlength{\rightskip}{0pt plus 5cm}int($\ast$ {\bf TplFunc}\mbox{[}NbTplPKG\mbox{]})(mmachine m)}} \label{template_8cpp_a95c0009400a7f8a271a9f8f84b7a0e4c} {\bfseries Initial value:} \begin{DoxyCode} { NULL, _CRbloc, _DSbloc, _GETblocValue, _GETblocName, _SETblocName, _SETblocValue, _CBblocChangeValue } \end{DoxyCode} Pointers to C functions that manipulate the VM for each scol function previously defined Definition at line 418 of file template.cpp. \hypertarget{template_8cpp_a9fb82289ed02d14c4137bc91c0128e33}{ \index{template.cpp@{template.cpp}!TplName@{TplName}} \index{TplName@{TplName}!template.cpp@{template.cpp}} \subsubsection[{TplName}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf TplName}\mbox{[}NbTplPKG\mbox{]}}} \label{template_8cpp_a9fb82289ed02d14c4137bc91c0128e33} {\bfseries Initial value:} \begin{DoxyCode} { "ObjBloc", "_CRbloc", "_DSbloc", "_GETblocValue", "_GETblocName", "_SETblocName", "_SETblocValue", "_CBblocChangeValue" } \end{DoxyCode} Scol function names Definition at line 402 of file template.cpp. \hypertarget{template_8cpp_a7f359b36c24b953bd273ccd63711234b}{ \index{template.cpp@{template.cpp}!TplNArg@{TplNArg}} \index{TplNArg@{TplNArg}!template.cpp@{template.cpp}} \subsubsection[{TplNArg}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf TplNArg}\mbox{[}NbTplPKG\mbox{]}}} \label{template_8cpp_a7f359b36c24b953bd273ccd63711234b} {\bfseries Initial value:} \begin{DoxyCode} { TYPTYPE, 1, 1, 1, 1, 2, 2, 3 } \end{DoxyCode} Nb of arguments of each scol function Definition at line 434 of file template.cpp. \hypertarget{template_8cpp_a3101c86c8a5f2e825fca960e3b4bf447}{ \index{template.cpp@{template.cpp}!TplType@{TplType}} \index{TplType@{TplType}!template.cpp@{template.cpp}} \subsubsection[{TplType}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf TplType}\mbox{[}NbTplPKG\mbox{]}}} \label{template_8cpp_a3101c86c8a5f2e825fca960e3b4bf447} {\bfseries Initial value:} \begin{DoxyCode} { NULL, "fun [Chn] ObjBloc", "fun [ObjBloc] I", "fun [ObjBloc] I", "fun [ObjBloc] S", "fun [ObjBloc S] I", "fun [ObjBloc I] I", "fun [ObjBloc fun [ObjBloc u0 I S] u1 u0] ObjBloc" } \end{DoxyCode} Prototypes of the scol functions Definition at line 450 of file template.cpp. \hypertarget{template_8cpp_a95981606817c56a4a3aa27218ae6e722}{ \index{template.cpp@{template.cpp}!ww@{ww}} \index{ww@{ww}!template.cpp@{template.cpp}} \subsubsection[{ww}]{\setlength{\rightskip}{0pt plus 5cm}cbmachine {\bf ww}}} \label{template_8cpp_a95981606817c56a4a3aa27218ae6e722} Scol machine declaration for MM macros. Definition at line 42 of file template.cpp.