Browse Source

+ Added gpm chapter

michael 25 years ago
parent
commit
56b8bb88c6
3 changed files with 56 additions and 19 deletions
  1. 52 18
      docs/gpm.tex
  2. 2 1
      docs/onechap.tex
  3. 2 0
      docs/units.tex

+ 52 - 18
docs/gpm.tex

@@ -151,7 +151,7 @@ None.
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_AnySingle}{GpmAnySingle},
 \seefl{Gpm\_AnySingle}{GpmAnySingle},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
-\seefl{Gpm\_StrictTriple{GpmStrictTriple},
+\seefl{Gpm\_StrictTriple}{GpmStrictTriple},
 \seefl{Gpm\_AnyTriple}{GpmAnyTriple}
 \seefl{Gpm\_AnyTriple}{GpmAnyTriple}
 \end{functionl}
 \end{functionl}
 
 
@@ -166,11 +166,11 @@ the \var{GPM\_SINGLE} flag, \var{False} otherwise.
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_AnyDoubmle}{GpmAnyDouble},
 \seefl{Gpm\_AnyDoubmle}{GpmAnyDouble},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
-\seefl{Gpm\_StrictTriple{GpmStrictTriple},
+\seefl{Gpm\_StrictTriple}{GpmStrictTriple},
 \seefl{Gpm\_AnyTriple}{GpmAnyTriple}
 \seefl{Gpm\_AnyTriple}{GpmAnyTriple}
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}{Gpm_AnyTriple}{GpmAnyTriple}
+\begin{functionl}{Gpm\_AnyTriple}{GpmAnyTriple}
 \Declaration
 \Declaration
 function Gpm\_AnyTriple(EventType : longint) : boolean;
 function Gpm\_AnyTriple(EventType : longint) : boolean;
 \Description
 \Description
@@ -179,11 +179,11 @@ function Gpm\_AnyTriple(EventType : longint) : boolean;
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_StrictSingle}{GpmStrictSingle},
 \seefl{Gpm\_AnyDoubmle}{GpmAnyDouble},
 \seefl{Gpm\_AnyDoubmle}{GpmAnyDouble},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
 \seefl{Gpm\_StrictDouble}{GpmStrictDouble},
-\seefl{Gpm\_StrictTriple{GpmStrictTriple},
+\seefl{Gpm\_StrictTriple}{GpmStrictTriple},
 \seefl{Gpm\_AnySingle}{GpmAnySingle}
 \seefl{Gpm\_AnySingle}{GpmAnySingle}
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}{Gpm_Close}{GpmClose}
+\begin{functionl}{Gpm\_Close}{GpmClose}
 \Declaration
 \Declaration
 function Gpm\_Close:longint;cdecl;external;
 function Gpm\_Close:longint;cdecl;external;
 \Description
 \Description
@@ -202,12 +202,12 @@ None.
 \Declaration
 \Declaration
 function Gpm\_FitValues(var x,y:longint):longint;cdecl;external;
 function Gpm\_FitValues(var x,y:longint):longint;cdecl;external;
 \Description
 \Description
-\var{Gpm_fitValues} changes \var{x} and \var{y} so they fit in the visible
+\var{Gpm\_fitValues} changes \var{x} and \var{y} so they fit in the visible
 screen. The actual mouse pointer is not affected by this function.
 screen. The actual mouse pointer is not affected by this function.
 \Errors
 \Errors
 None.
 None.
 \SeeAlso
 \SeeAlso
-\seefl{Gpm\_FitValuesM}{Gpm\_FitValuesM},
+\seefl{Gpm\_FitValuesM}{GpmFitValuesM},
 \end{functionl}
 \end{functionl}
 
 
 \begin{functionl}{Gpm\_FitValuesM}{GpmFitValuesM}
 \begin{functionl}{Gpm\_FitValuesM}{GpmFitValuesM}
@@ -223,11 +223,11 @@ None.
 \seefl{Gpm\_FitValues}{GpmFitValues},
 \seefl{Gpm\_FitValues}{GpmFitValues},
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}{Gpm_GetEvent}{GpmGetEvent}
+\begin{functionl}{Gpm\_GetEvent}{GpmGetEvent}
 \Declaration
 \Declaration
 function Gpm\_GetEvent(var Event:TGpmEvent):longint;cdecl;external;
 function Gpm\_GetEvent(var Event:TGpmEvent):longint;cdecl;external;
 \Description
 \Description
-\var{Gpm\_GetEvent} Reads an event from the file descriptor \var{gpm_fd}.
+\var{Gpm\_GetEvent} Reads an event from the file descriptor \var{gpm\_fd}.
 This file is only for internal use and should never be called by a client
 This file is only for internal use and should never be called by a client
 application. 
 application. 
 
 
@@ -376,39 +376,73 @@ None.
 \Declaration
 \Declaration
 function Gpm\_RaiseRoi(which:PGpmRoi; before:PGpmRoi):PGpmRoi;cdecl;external;
 function Gpm\_RaiseRoi(which:PGpmRoi; before:PGpmRoi):PGpmRoi;cdecl;external;
 \Description
 \Description
-\var{Gpm\_RaiseRoi} raises the {\em region of interest} \var{which}
+\var{Gpm\_RaiseRoi} raises the {\em region of interest} \var{which} till it
+is on top of region \var{before}. If \var{before} is nil then the region is
+put on top of the stack. The returned value is the top of the stack.
 \Errors
 \Errors
+None.
 \SeeAlso
 \SeeAlso
+\seefl{Gpm\_PushRoi}{GpmPushRoi},
+\seefl{Gpm\_PopRoi}{GpmPopRoi}, 
+\seefl{Gpm\_LowerRoi}{GpmLowerRoi} 
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}
+\begin{functionl}{Gpm_Repeat}{GpmRepeat}
 \Declaration
 \Declaration
-function Gpm_Repeat(millisec:longint):longint;cdecl;external;
+function Gpm\_Repeat(millisec:longint):longint;cdecl;external;
 \Description
 \Description
+\var{Gpm\_Repeat} returns 1 of no mouse event arrives in the next
+\var{millisec} miiliseconds, it returns 0 otherwise.
 \Errors
 \Errors
+None.
 \SeeAlso
 \SeeAlso
+\seefl{Gpm\_GetEvent}{GpmGetEvent}
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}
+\begin{functionl}{Gpm\_StrictDouble}{GpmStrictDouble}
 \Declaration
 \Declaration
-function Gpm_StrictDouble(EventType : longint) : boolean;
+function Gpm\_StrictDouble(EventType : longint) : boolean;
 \Description
 \Description
+\var{Gpm\_StrictDouble} returns true if \var{EventType} contains only a 
+doubleclick event, \var{False} otherwise.
 \Errors
 \Errors
+None.
 \SeeAlso
 \SeeAlso
+\seefl{Gpm\_StrictSingle}{GpmStrictSingle},
+\seefl{Gpm\_AnyTriple}{GpmAnyTriple},
+\seefl{Gpm\_AnyDouble}{GpmAnyDouble},
+\seefl{Gpm\_StrictTriple}{GpmStrictTriple},
+\seefl{Gpm\_AnySingle}{GpmAnySingle}
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}
+\begin{functionl}{Gpm\_StrictSingle}{GpmStrictSingle}
 \Declaration
 \Declaration
-function Gpm_StrictSingle(EventType : longint) : boolean;
+function Gpm\_StrictSingle(EventType : longint) : boolean;
 \Description
 \Description
+\var{Gpm\_StrictDouble} returns \var{True} if \var{EventType} contains only a 
+singleclick event, \var{False} otherwise. 
 \Errors
 \Errors
+None.
 \SeeAlso
 \SeeAlso
+\seefl{Gpm\_AnyTriple}{GpmAnyTriple},
+\seefl{Gpm\_StrictDouble}{GpmStrictDouble},
+\seefl{Gpm\_AnyDouble}{GpmAnyDouble}, 
+\seefl{Gpm\_StrictTriple}{GpmStrictTriple},
+\seefl{Gpm\_AnySingle}{GpmAnySingle}
 \end{functionl}
 \end{functionl}
 
 
-\begin{functionl}
+\begin{functionl}{Gpm\_StrictTriple}{GpmStrictTriple}
 \Declaration
 \Declaration
-function Gpm_StrictTriple(EventType : longint) : boolean;
+function Gpm\_StrictTriple(EventType : longint) : boolean;
 \Description
 \Description
+\var{Gpm\_StrictTriple} returns true if \var{EventType} contains only a
+triple click event, \var{False} otherwise.
 \Errors
 \Errors
+None.
 \SeeAlso
 \SeeAlso
+\seefl{Gpm\_AnyTriple}{GpmAnyTriple},
+\seefl{Gpm\_StrictDouble}{GpmStrictDouble},
+\seefl{Gpm\_AnyDouble}{GpmAnyDouble}, 
+\seefl{Gpm\_StrictSingle}{GpmStrictSingle},
+\seefl{Gpm\_AnySingle}{GpmAnySingle}
 \end{functionl}
 \end{functionl}

+ 2 - 1
docs/onechap.tex

@@ -30,11 +30,12 @@
 %\input{dos.tex}
 %\input{dos.tex}
 %\input{getopts.tex}
 %\input{getopts.tex}
 %\input{go32.tex}
 %\input{go32.tex}
+\input{gpm.tex}
 %\input{graph.tex}
 %\input{graph.tex}
 %\input{heaptrc.tex}
 %\input{heaptrc.tex}
 %\input{ipc.tex}
 %\input{ipc.tex}
 %\input{ide.tex}
 %\input{ide.tex}
-\input{linux.tex}
+%\input{linux.tex}
 %\input{mmx.tex}
 %\input{mmx.tex}
 %\input{mouse.tex}
 %\input{mouse.tex}
 %\input{objects.tex}
 %\input{objects.tex}

+ 2 - 0
docs/units.tex

@@ -116,6 +116,8 @@ lookup.
 \input{dos.tex}
 \input{dos.tex}
 % The getopts unit
 % The getopts unit
 \input{getopts.tex}
 \input{getopts.tex}
+% The GPM unit
+\input{gpm.tex}
 % the go32 unit
 % the go32 unit
 \input{go32.tex}
 \input{go32.tex}
 % The graph unit
 % The graph unit