DC attribute operations
[GDI functions]

Defines

• #define GetBkColor(hdc)   (gal_pixel) GetDCAttr (hdc, DC_ATTR_BK_COLOR)

  Gets the background color of a DC.
  

• #define GetBkMode(hdc)   (int) GetDCAttr (hdc, DC_ATTR_BK_MODE)

  Gets the background mode of a DC.
  

• #define GetPenColor(hdc)   (gal_pixel) GetDCAttr (hdc, DC_ATTR_PEN_COLOR)

  Gets the pen color of a DC.
  

• #define GetBrushColor(hdc)   (gal_pixel) GetDCAttr (hdc, DC_ATTR_BRUSH_COLOR)

  Gets the brush color of a DC.
  

• #define GetTextColor(hdc)   (gal_pixel) GetDCAttr (hdc, DC_ATTR_TEXT_COLOR)

  Gets the text color of a DC.
  

• #define GetTabStop(hdc)   (int) GetDCAttr (hdc, DC_ATTR_TAB_STOP)

  Gets the tabstop value of a DC.
  

• #define SetBkColor(hdc, color)   (gal_pixel) SetDCAttr (hdc, DC_ATTR_BK_COLOR, (DWORD) color)

  Sets the background color of a DC to a new value.
  

• #define SetBkMode(hdc, mode)   (int) SetDCAttr (hdc, DC_ATTR_BK_MODE, (DWORD) mode)

  Sets the background color of a DC to a new mode.
  

• #define SetPenColor(hdc, color)   (gal_pixel) SetDCAttr (hdc, DC_ATTR_PEN_COLOR, (DWORD) color)

  Sets the pen color of a DC to a new value.
  

• #define SetBrushColor(hdc, color)   (gal_pixel) SetDCAttr (hdc, DC_ATTR_BRUSH_COLOR, (DWORD) color)

  Sets the brush color of a DC to a new value.
  

• #define SetTextColor(hdc, color)   (gal_pixel) SetDCAttr (hdc, DC_ATTR_TEXT_COLOR, (DWORD) color)

  Sets the text color of a DC to a new value.
  

• #define SetTabStop(hdc, value)   (int) SetDCAttr (hdc, DC_ATTR_TAB_STOP, (DWORD) value)

  Sets the tabstop of a DC to a new value.
  

Functions

• MG_EXPORT Uint32 GUIAPI GetDCAttr (HDC hdc, int attr)

  Gets a specified attribute value of a DC.
  

• MG_EXPORT Uint32 GUIAPI SetDCAttr (HDC hdc, int attr, Uint32 value)

  Sets a specified attribute value of a DC.
  

• MG_EXPORT int GUIAPI GetRasterOperation (HDC hdc)

  Gets the raster operation of a DC.
  

• MG_EXPORT int GUIAPI SetRasterOperation (HDC hdc, int rop)

  Sets the raster operation of a DC to a new value.
  

---

Define Documentation

#define GetBkColor (  hdc   )     (gal_pixel) GetDCAttr (hdc, DC_ATTR_BK_COLOR)

Gets the background color of a DC. Parameters: hdc  The device context. Returns: The background pixel value of the DC hdc. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetBkColor is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetBkColor Definition at line 1968 of file gdi.h.

#define GetBkMode (  hdc   )     (int) GetDCAttr (hdc, DC_ATTR_BK_MODE)

Gets the background mode of a DC. Parameters: hdc  The device context. Returns: The background mode of the DC hdc. Return values: BM_TRANSPARENT\n  Indicate that reserve the background untouched when drawing text. BM_OPAQUE\n  Indicate that erase the background with background color when drawing text. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetBkMode is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetBkMode Definition at line 1989 of file gdi.h.

#define GetBrushColor (  hdc   )     (gal_pixel) GetDCAttr (hdc, DC_ATTR_BRUSH_COLOR)

Gets the brush color of a DC. Parameters: hdc  The device context. Returns: The brush color (pixel value) of the DC hdc. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetBrushColor is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetBrushColor Definition at line 2019 of file gdi.h.

#define GetPenColor (  hdc   )     (gal_pixel) GetDCAttr (hdc, DC_ATTR_PEN_COLOR)

Gets the pen color of a DC. Parameters: hdc  The device context. Returns: The pen color (pixel value) of the DC hdc. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetPenColor is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetPenColor Definition at line 2004 of file gdi.h.

#define GetTabStop (  hdc   )     (int) GetDCAttr (hdc, DC_ATTR_TAB_STOP)

Gets the tabstop value of a DC. Parameters: hdc  The device context. Returns: The tabstop value of the DC hdc. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetTabStop is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetTabStop Definition at line 2049 of file gdi.h.

#define GetTextColor (  hdc   )     (gal_pixel) GetDCAttr (hdc, DC_ATTR_TEXT_COLOR)

Gets the text color of a DC. Parameters: hdc  The device context. Returns: The text color (pixel value) of the DC hdc. Note: Defined as a macro calling GetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, GetTextColor is defined as a function, and have the same semantics as this macro. See also: GetDCAttr, SetTextColor Definition at line 2034 of file gdi.h.

#define SetBkColor (  hdc, color   )     (gal_pixel) SetDCAttr (hdc, DC_ATTR_BK_COLOR, (DWORD) color)

Sets the background color of a DC to a new value. Parameters: hdc  The device context. color  The new background color (pixel value). Returns: The old background pixel value of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetBkColor is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetBkColor Definition at line 2065 of file gdi.h.

#define SetBkMode (  hdc, mode   )     (int) SetDCAttr (hdc, DC_ATTR_BK_MODE, (DWORD) mode)

Sets the background color of a DC to a new mode. Parameters: hdc  The device context. mode  The new background mode, be can one of the following values: BM_TRANSPARENT Indicate that reserve the background untouched when drawing text. BM_OPAQUE Indicate that erase the background with background color when drawing text. Returns: The old background mode of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetBkMode is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetBkMode Definition at line 2089 of file gdi.h.

#define SetBrushColor (  hdc, color   )     (gal_pixel) SetDCAttr (hdc, DC_ATTR_BRUSH_COLOR, (DWORD) color)

Sets the brush color of a DC to a new value. Parameters: hdc  The device context. color  The new brush color (pixel value). Returns: The old brush pixel value of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetBrushColor is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetBrushColor Definition at line 2123 of file gdi.h.

#define SetPenColor (  hdc, color   )     (gal_pixel) SetDCAttr (hdc, DC_ATTR_PEN_COLOR, (DWORD) color)

Sets the pen color of a DC to a new value. Parameters: hdc  The device context. color  The new pen color (pixel value). Returns: The old pen pixel value of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetPenColor is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetPenColor Definition at line 2106 of file gdi.h.

#define SetTabStop (  hdc, value   )     (int) SetDCAttr (hdc, DC_ATTR_TAB_STOP, (DWORD) value)

Sets the tabstop of a DC to a new value. Parameters: hdc  The device context. value  The new tabstop value in pixels. Returns: The old tabstop value in pixels of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetTabStop is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetTabStop Definition at line 2157 of file gdi.h.

#define SetTextColor (  hdc, color   )     (gal_pixel) SetDCAttr (hdc, DC_ATTR_TEXT_COLOR, (DWORD) color)

Sets the text color of a DC to a new value. Parameters: hdc  The device context. color  The new text color (pixel value). Returns: The old text color (pixel value) of the DC hdc. Note: Defined as a macro calling SetDCAttr for _USE_NEWGAL. If _USE_NEWGAL is not defined, SetTextColor is defined as a function, and have the same semantics as this macro. See also: SetDCAttr, GetTextColor Definition at line 2140 of file gdi.h.

---

Function Documentation

Uint32 GUIAPI GetDCAttr (  HDC  hdc, int  attr )

Gets a specified attribute value of a DC. This function retrives a specified attribute value of the DC hdc. Parameters: hdc  The device context. attr  The attribute to be retrived, can be one of the following values: DC_ATTR_BK_COLOR Background color. DC_ATTR_BK_MODE Background mode. DC_ATTR_PEN_TYPE Pen type. DC_ATTR_PEN_CAP_STYLE Cap style of pen. DC_ATTR_PEN_JOIN_STYLE Join style of pen. DC_ATTR_PEN_COLOR Pen color. DC_ATTR_BRUSH_TYPE Brush type. DC_ATTR_BRUSH_COLOR Brush color. DC_ATTR_TEXT_COLOR Text color. DC_ATTR_TAB_STOP Tabstop width. Returns: The attribute value. Note: Only defined for _USE_NEWGAL. See also: SetDCAttr

int GUIAPI GetRasterOperation (  HDC  hdc  )

Gets the raster operation of a DC. This function gets the raster operation of the DC hdc. Parameters: hdc  The device context. Returns: The current raster operation of the DC hdc. Return values: ROP_SET\n  Set to the new pixel value, erase original pixel on the surface. ROP_AND\n  AND'd the new pixel value with the original pixel on the surface. ROP_OR\n  OR'd the new pixel value with the original pixel on the surface. ROP_XOR\n  XOR'd the new pixel value with the original pixel on the surface. Note: Only defined for _USE_NEWGAL. See also: SetRasterOperation

Uint32 GUIAPI SetDCAttr (  HDC  hdc, int  attr, Uint32  value )

Sets a specified attribute value of a DC. This function sets a specified attribute value of the DC hdc. Parameters: hdc  The device context. attr  The attribute to be set. value  The attribute value. Returns: The old attribute value. Note: Only defined for _USE_NEWGAL. See also: GetDCAttr

int GUIAPI SetRasterOperation (  HDC  hdc, int  rop )

Sets the raster operation of a DC to a new value. This function sets the raster operation of the DC hdc to the new value rop. Parameters: hdc  The device context. rop  The new raster operation, can be one of the following values: ROP_SET Set to the new pixel value, erase original pixel on the surface. ROP_AND AND'd the new pixel value with the original pixel on the surface. ROP_OR OR'd the new pixel value with the original pixel on the surface. ROP_XOR XOR'd the new pixel value with the original pixel on the surface. Returns: The old raster operation of the DC hdc. Note: Only defined for _USE_NEWGAL. See also: GetRasterOperation

---