[Win32forth-cvs] win32forth/src/gdi gdiBase.f,1.4,1.5 gdiPen.f,1.2,1.3 gdiStruct.f,1.2,1.3

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/win32forth/win32forth/src/gdi
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12709/src/gdi

Modified Files:
	gdiBase.f gdiPen.f gdiStruct.f 
Log Message:
DexH style documention added.

Index: gdiBase.f
===================================================================
RCS file: /cvsroot/win32forth/win32forth/src/gdi/gdiBase.f,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** gdiBase.f	17 Dec 2005 15:11:19 -0000	1.4
--- gdiBase.f	24 Dec 2005 11:58:00 -0000	1.5
***************
*** 1,2 ****
--- 1,4 ----
+ 
+ \ *D doc\classes\
  \ *! gdiBase
  \ *T GdiObject -- Base class for GDI objects
***************
*** 71,75 ****
  \ *G Get the type of the object.  \n
  \ ** Possible return values are:
! \ *L OBJ_BITMAP         | Bitmap |
  \ *| OBJ_BRUSH          | Brush |
  \ *| OBJ_COLORSPACE     | Color space |
--- 73,78 ----
  \ *G Get the type of the object.  \n
  \ ** Possible return values are:
! \ *L
! \ *| OBJ_BITMAP         | Bitmap |
  \ *| OBJ_BRUSH          | Brush |
  \ *| OBJ_COLORSPACE     | Color space |

Index: gdiStruct.f
===================================================================
RCS file: /cvsroot/win32forth/win32forth/src/gdi/gdiStruct.f,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** gdiStruct.f	6 Nov 2005 09:09:27 -0000	1.2
--- gdiStruct.f	24 Dec 2005 11:58:00 -0000	1.3
***************
*** 1,7 ****
! \ gdiStruct.f
! \
! \ Written by Dirk Busch
! \ Sonntag, Oktober 09 2005
! \ Licence: Public Domain
  
  cr .( Loading GDI class library - Structs...)
--- 1,10 ----
! 
! \ *D doc\classes\
! \ *! gdiStruct
! \ *T gdiStruct -- Wrapper classes for GDI structs.
! \ *Q Version 1.0
! \ ** This GDI class library was written and placed in the Public Domain
! \ ** in 2005 by Dirk Busch
! \ *S Glossary
  
  cr .( Loading GDI class library - Structs...)
***************
*** 24,30 ****
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ Wrapper class for a POINT-Struct
! \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  :class gdiPOINT <super object
  
  Record: &POINT
--- 27,34 ----
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ *W <a name="gdiPOINT"></a>
  :class gdiPOINT <super object
+ \ *G Wrapper class for a POINT struct.
+ \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  
  Record: &POINT
***************
*** 40,58 ****
          ;M
  
! :M GetX:        ( -- x )        x ;M
! :M GetY:        ( -- y )        y ;M
! :M SetX:        ( x -- )        to x ;M
! :M SetY:        ( y -- )        to y ;M
  
! :M Addr:        ( -- addr )     &POINT ;M
! :M Size:        ( -- size )     sizeof(POINT) ;M
  
  ;class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ Wrapper class for a COLOREF-Struct
! \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! 
  :class gdiCOLORREF <super object
  
  Record: &COLORREF
--- 44,86 ----
          ;M
  
! :M GetX:        ( -- x )
! \ *G Get the x value of the point.
!                 x ;M
  
! :M GetY:        ( -- y )
! \ *G Get the y value of the point.
!                 y ;M
! 
! :M SetX:        ( x -- )
! \ *G Set the x value of the point.
!                 to x ;M
! 
! :M SetY:        ( y -- )
! \ *G Get the y value of the point.
!                 to y ;M
! 
! :M Addr:        ( -- addr )
! \ *G Get the address of the point struct.
!                 &POINT ;M
! 
! :M Size:        ( -- size )
! \ *G Get the site of the point struct
!                 sizeof(POINT) ;M
  
  ;class
+ \ *G End of gdiPOINT class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ *W <a name="gdiCOLORREF"></a>
  :class gdiCOLORREF <super object
+ \ *G Wrapper class for a COLORREF struct. \n
+ \ ** A COLORREF value is used to specify an RGB color.
+ \ ** When specifying an explicit RGB color, the COLORREF value has the following
+ \ ** hexadecimal form: 0x00bbggrr \n
+ \ ** The low-order byte contains a value for the relative intensity of red;
+ \ ** the second byte contains a value for green; and the third byte contains a
+ \ ** value for blue. The high-order byte must be zero. The maximum value for a
+ \ ** single byte is 0xFF.
+ \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  
  Record: &COLORREF
***************
*** 60,64 ****
          byte g
          byte b
!         byte alpha
  ;RecordSize: sizeof(COLORREF)
  
--- 88,92 ----
          byte g
          byte b
!         byte reserved
  ;RecordSize: sizeof(COLORREF)
  
***************
*** 82,86 ****
          0 to g
          0 to b
!         0 to alpha
  
          \ init &CHOOSECOLOR record
--- 110,114 ----
          0 to g
          0 to b
!         0 to reserved
  
          \ init &CHOOSECOLOR record
***************
*** 97,117 ****
          ;M
  
! :M SetAlpha:    ( alpha -- )    to alpha ;M
! :M SetRValue:   ( r -- )        to r ;M
! :M SetGValue:   ( g -- )        to g ;M
! :M SetBValue:   ( b -- )        to b ;M
! :M GetAlpha:    ( alpha -- )    alpha ;M
! :M GetRValue:   ( -- r )        r ;M
! :M GetGValue:   ( -- g )        g ;M
! :M GetBValue:   ( -- b )        b ;M
! :M SetColor:    ( colorref -- ) 0x00ffffff and &COLORREF ! ;M
! :M SetSysColor: ( n -- )        call GetSysColor &COLORREF ! ;M
! :M GetColor:    ( -- colorref ) &COLORREF @ 0x00ffffff and ;M
! :M SetRGB:      ( r g b -- )    SetBValue: self SetGValue: self SetRValue: self ;M
  
! :M Addr:        ( -- addr )     &COLORREF ;M
! :M Size:        ( -- size )     sizeof(COLORREF) ;M
  
  :M Choose:      ( hWnd -- f )
          to hwndOwner
          GetColor: self to rgbResult
--- 125,212 ----
          ;M
  
! :M SetRValue:   ( r -- )
! \ *G Set the red value of the color
!         to r ;M
  
! :M SetGValue:   ( g -- )
! \ *G Set the green value of the color
!         to g ;M
! 
! :M SetBValue:   ( b -- )
! \ *G Set the blue value of the color
!         to b ;M
! 
! :M GetRValue:   ( -- r )
! \ *G Get the red value of the color
!         r ;M
! 
! :M GetGValue:   ( -- g )
! \ *G Get the green value of the color
!         g ;M
! 
! :M GetBValue:   ( -- b )
! \ *G Get the blue value of the color
!         b ;M
! 
! :M SetColor:    ( colorref -- )
! \ *G Set the color
!         0x00ffffff and &COLORREF ! ;M
! 
! :M SetSysColor: ( n -- )
! \ *G Set a system color. Possible values are:
! \ *L
! \ *| COLOR_3DDKSHADOW | Dark shadow for three-dimensional display elements. |
! \ *| COLOR_3DFACE, COLOR_BTNFACE | Face color for three-dimensional display elements and for dialog box backgrounds. |
! \ *| COLOR_3DHILIGHT | Highlight color for three-dimensional display elements (for edges facing the light source.) |
! \ *| COLOR_3DHIGHLIGHT | Highlight color for three-dimensional display elements (for edges facing the light source.) |
! \ *| COLOR_BTNHILIGHT | Highlight color for three-dimensional display elements (for edges facing the light source.) |
! \ *| COLOR_BTNHIGHLIGHT | Highlight color for three-dimensional display elements (for edges facing the light source.) |
! \ *| COLOR_3DLIGHT | Light color for three-dimensional display elements (for edges facing the light source.) |
! \ *| COLOR_3DSHADOW, COLOR_BTNSHADOW | Shadow color for three-dimensional display elements (for edges facing away from the light source). |
! \ *| COLOR_ACTIVEBORDER | Active window border. |
! \ *| COLOR_ACTIVECAPTION | Active window title bar. Windows 98, Windows 2000: Specifies the left side color in the color gradient of an active window's title bar if the gradient effect is enabled. |
! \ *| COLOR_APPWORKSPACE | Background color of multiple document interface (MDI) applications. |
! \ *| COLOR_BACKGROUND, COLOR_DESKTOP | Desktop. |
! \ *| COLOR_BTNTEXT | Text on push buttons. |
! \ *| COLOR_CAPTIONTEXT | Text in caption, size box, and scroll bar arrow box. |
! \ *| COLOR_GRADIENTACTIVECAPTION | Windows 98, Windows 2000: Right side color in the color gradient of an active window's title bar.
! \ *| COLOR_ACTIVECAPTION | Windows 98, Windows 2000: specifies the left side color.
! \ *| COLOR_GRADIENTINACTIVECAPTION | Windows 98, Windows 2000: Right side color in the color gradient of an inactive window's title bar.
! \ *| COLOR_INACTIVECAPTION | Windows 98, Windows 2000: specifies the left side color. |
! \ *| COLOR_GRAYTEXT | Grayed (disabled) text. This color is set to 0 if the current display driver does not support a solid gray color. |
! \ *| COLOR_HIGHLIGHT | Item(s) selected in a control. |
! \ *| COLOR_HIGHLIGHTTEXT | Text of item(s) selected in a control. |
! \ *| COLOR_HOTLIGHT | Windows 98, Windows 2000: Color for a hot-tracked item. Single clicking a hot-tracked item executes the item. |
! \ *| COLOR_INACTIVEBORDER | Inactive window border. |
! \ *| COLOR_INACTIVECAPTION | Inactive window caption. Windows 98, Windows 2000: Specifies the left side color in the color gradient of an inactive window's title bar if the gradient effect is enabled. |
! \ *| COLOR_INACTIVECAPTIONTEXT | Color of text in an inactive caption. |
! \ *| COLOR_INFOBK | Background color for tooltip controls. |
! \ *| COLOR_INFOTEXT | Text color for tooltip controls. |
! \ *| COLOR_MENU | Menu background. |
! \ *| COLOR_MENUTEXT | Text in menus. |
! \ *| COLOR_SCROLLBAR | Scroll bar gray area. |
! \ *| COLOR_WINDOW | Window background. |
! \ *| COLOR_WINDOWFRAME | Window frame. |
! \ *| COLOR_WINDOWTEXT | Text in windows. |
!         call GetSysColor &COLORREF ! ;M
! 
! :M GetColor:    ( -- colorref )
! \ *G Get the color
!         &COLORREF @ ;M
! 
! :M SetRGB:      ( r g b -- )
! \ *G Set the red, green and blue values of the color
!         SetBValue: self SetGValue: self SetRValue: self ;M
! 
! :M Addr:        ( -- addr )
! \ *G Get the address of the COLORREF struct
!         &COLORREF ;M
! 
! :M Size:        ( -- size )
! \ *G Get the size of the COLORREF struct
!         sizeof(COLORREF) ;M
  
  :M Choose:      ( hWnd -- f )
+ \ *G Open the windows dialog for choosing a color.
          to hwndOwner
          GetColor: self to rgbResult
***************
*** 123,149 ****
  \ return address and length of the user defined custom colors
  :M CustomColors:        ( -- addr len )
          CustomColors 64 ;M
  
  ;class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ Wrapper class for a RGBQUAD-Struct
! \
! \ The RGBQUAD structure describes a color consisting of relative intensities
! \ of red, green, and blue.
! \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! 
  :class gdiRGBQUAD <super gdiCOLORREF
  
! :M SetAlpha:    ( alpha -- )    drop ;M
! :M GetAlpha:    ( -- alpha )    0 ;M
  
  ;class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ Wrapper class for a SIZE-struct
! \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! 
  :class gdiSIZE <super object
  
  Record: &SIZE
--- 218,252 ----
  \ return address and length of the user defined custom colors
  :M CustomColors:        ( -- addr len )
+ \ *G Get the address and length (in cells) of the CustomColors array
+ \ ** used by Choose:
          CustomColors 64 ;M
  
  ;class
+ \ *G End of gdiCOLORREF class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ *W <a name="gdiRGBQUAD"></a>
  :class gdiRGBQUAD <super gdiCOLORREF
+ \ *G Wrapper class for a RGBQUAD struct \n
+ \ ** The RGBQUAD structure describes a color consisting of relative
+ \ ** intensities of red, green, and blue. \n
+ \ ** The bmiColors member of the BITMAPINFO structure consists of an array
+ \ ** of RGBQUAD structures. \n
+ \ ** Note: This class doesn't have any private methods. For a description
+ \ ** of the methods see the gdiCOLORREF class.
+ \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  
! :M ClassInit:   ( -- )
!         ClassInit: super
!         ;M
  
  ;class
+ \ *G End of gdiRGBQUAD class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ *W <a name="gdiSIZE"></a>
  :class gdiSIZE <super object
+ \ *G Wrapper class for a SIZE struct
+ \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  
  Record: &SIZE
***************
*** 159,177 ****
          ;M
  
! :M GetX:        ( -- x )        cx ;M
! :M GetY:        ( -- y )        cy ;M
! :M SetX:        ( x -- )        to cx ;M
! :M SetY:        ( y -- )        to cy ;M
  
! :M Addr:        ( -- addr )     &SIZE ;M
! :M Size:        ( -- size )     sizeof(SIZE) ;M
  
  ;class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ Wrapper class for a TEXTMETRIC-struct
! \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! 
  :class gdiTEXTMETRIC <super object
  
  Record: &TEXTMETRIC
--- 262,297 ----
          ;M
  
! :M GetX:        ( -- x )
! \ *G Get the x value
!         cx ;M
  
! :M GetY:        ( -- y )
! \ *G Get the y value
!         cy ;M
! 
! :M SetX:        ( x -- )
! \ *G Set the x value
!         to cx ;M
! 
! :M SetY:        ( y -- )
! \ *G Set the y value
!         to cy ;M
! 
! :M Addr:        ( -- addr )
! \ *G Get the address of the SIZE struct
!         &SIZE ;M
! 
! :M Size:        ( -- size )
! \ *G Get the size of the SIZE struct
!         sizeof(SIZE) ;M
  
  ;class
+ \ *G End of gdiSIZE class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
! \ *W <a name="gdiTEXTMETRIC"></a>
  :class gdiTEXTMETRIC <super object
+ \ *G Wrapper class for a TEXTMETRIC struct
+ \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  
  Record: &TEXTMETRIC
***************
*** 246,252 ****
--- 366,376 ----
  
  :M Addr:                 ( -- addr ) &TEXTMETRIC ;M
+ \ *G Get the address of the TEXTMETRIC struct.
+ 
  :M Size:                 ( -- size ) sizeof(TEXTMETRIC) ;M
+ \ *G Get the size of the TEXTMETRIC struct.
  
  ;class
+ \ *G End of gdiTEXTMETRIC class
  
  \ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
***************
*** 349,350 ****
--- 473,476 ----
  
  module
+ 
+ \ *Z

Index: gdiPen.f
===================================================================
RCS file: /cvsroot/win32forth/win32forth/src/gdi/gdiPen.f,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** gdiPen.f	17 Dec 2005 15:11:19 -0000	1.2
--- gdiPen.f	24 Dec 2005 11:58:00 -0000	1.3
***************
*** 1,2 ****
--- 1,4 ----
+ 
+ \ *D doc\classes\
  \ *! gdiPen
  \ *T GdiPen -- Class for GDI Pens
***************
*** 42,46 ****
  :M SetStyle:    ( style -- )
  \ *G Set Syle of the pen. Possible values are:
! \ *L PS_SOLID       | The pen is solid. |
  \ *| PS_DASH        | The pen is dashed. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_DOT         | The pen is dotted. This style is valid only when the pen width is one or less in device units. |
--- 44,49 ----
  :M SetStyle:    ( style -- )
  \ *G Set Syle of the pen. Possible values are:
! \ *L
! \ *| PS_SOLID       | The pen is solid. |
  \ *| PS_DASH        | The pen is dashed. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_DOT         | The pen is dotted. This style is valid only when the pen width is one or less in device units. |
***************
*** 48,52 ****
  \ *| PS_DASHDOTDOT  | The pen has alternating dashes and double dots. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_NULL        | The pen is invisible. |
! \ *| PS_INSIDEFRAME | The pen is solid. When this pen is used in any GDI drawing function that takes a bounding rectangle, the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. This applies only to geometric pens. |
          to style ;M
  
--- 51,55 ----
  \ *| PS_DASHDOTDOT  | The pen has alternating dashes and double dots. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_NULL        | The pen is invisible. |
! \ *| PS_INSIDEFRAME | The pen is solid. When this pen is used the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. Only for geometric pens. |
          to style ;M
  
***************
*** 86,90 ****
  :M GetStyle:    ( -- style )
  \ *G Get Syle of the pen. Possible values are:
! \ *L PS_SOLID       | The pen is solid. |
  \ *| PS_DASH        | The pen is dashed. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_DOT         | The pen is dotted. This style is valid only when the pen width is one or less in device units. |
--- 89,94 ----
  :M GetStyle:    ( -- style )
  \ *G Get Syle of the pen. Possible values are:
! \ *L
! \ *| PS_SOLID       | The pen is solid. |
  \ *| PS_DASH        | The pen is dashed. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_DOT         | The pen is dotted. This style is valid only when the pen width is one or less in device units. |
***************
*** 92,96 ****
  \ *| PS_DASHDOTDOT  | The pen has alternating dashes and double dots. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_NULL        | The pen is invisible. |
! \ *| PS_INSIDEFRAME | The pen is solid. When this pen is used in any GDI drawing function that takes a bounding rectangle, the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. This applies only to geometric pens. |
          style ;M
  
--- 96,100 ----
  \ *| PS_DASHDOTDOT  | The pen has alternating dashes and double dots. This style is valid only when the pen width is one or less in device units. |
  \ *| PS_NULL        | The pen is invisible. |
! \ *| PS_INSIDEFRAME | The pen is solid. When this pen is used the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. This applies only to geometric pens. |
          style ;M