Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gdk::GCValues Class Reference

A GdkGCValues C++ wrapper class. More...

#include <xfc/gdk/gc.hh>

Inheritance diagram for Xfc::Gdk::GCValues:

Xfc::StackObject List of all members.

Constructors

Public Member Functions

Accessors
Methods

Detailed Description

A GdkGCValues C++ wrapper class.

A graphics context is created with a set of default values. Any of these values can be set individually by calling one of the Gdk::GC methods, such as Gdk::GC::set_foreground or Gdk::GC::set_fill().

The GCValues object allows you to set multiple values at once when constructing or modifying a graphics context. GCValues manages the GdkGCValuesMask bit flags internally, so you don't have to worry. Just set the values you want and then pass your GCValues object to the Gdk::GC constructor, or the Gdk::GC::set_values method if your modifying the graphics context later. You can retreive the currently set values for a Gdk::GC by passing a GCValues object to Gdk::GC::get_values(). If you want to reuse the same GCValues object you can unset individual values by calling the corresponding unset_() method, or you reset the entire object to its gfcal state by calling reset(). This will free any set pixmaps and reset the bit flags to zero.


Constructor & Destructor Documentation

Xfc::Gdk::GCValues::GCValues ( const GCValues src  ) 

Copy constructor.

Parameters:
src The source GCValues.


Member Function Documentation

GCValues& Xfc::Gdk::GCValues::operator= ( const GCValues src  ) 

Assignemnt operator.

Parameters:
src The source GCValues.

void Xfc::Gdk::GCValues::set_foreground ( const Color color  ) 

Sets the foreground color for a graphics context.

Parameters:
color The new foreground color.

void Xfc::Gdk::GCValues::set_background ( const Color color  ) 

Sets the background color for a graphics context.

Parameters:
color The new background color.

void Xfc::Gdk::GCValues::set_function ( Function  function  ) 

Determines how the current pixel values and the pixel values being drawn are combined to produce the final pixel values.

Parameters:
function The bitwise operation to use when drawing.

void Xfc::Gdk::GCValues::set_fill ( Fill  fill  ) 

Set the fill mode for a graphics context.

Parameters:
fill The new fill mode.

void Xfc::Gdk::GCValues::set_tile ( Pixmap tile  ) 

Set a tile pixmap for a graphics context.

Parameters:
tile The new tile pixmap.
This will only be used if the fill mode is Gdk::TILED.

void Xfc::Gdk::GCValues::set_stipple ( Bitmap stipple  ) 

Set the stipple bitmap for a graphics context.

Parameters:
stipple The new stipple bitmap.
The stipple will only be used if the fill mode is Gdk::STIPPLED or Gdk::OPAQUE_STIPPLED.

void Xfc::Gdk::GCValues::set_clip_mask ( Bitmap mask  ) 

Sets the clip mask for a graphics context from a bitmap.

Parameters:
mask A bitmap.
The clip mask is interpreted relative to the clip origin (see Gdk::GC::set_clip_origin()).

void Xfc::Gdk::GCValues::set_subwindow_mode ( SubwindowMode  mode  ) 

Sets how drawing with this graphics context on a window will affect child windows of that window.

Parameters:
mode The subwindow mode.

void Xfc::Gdk::GCValues::set_ts_origin ( int  x,
int  y 
)

Set the origin when using tiles or stipples with the graphics context.

Parameters:
x The X coordinate of the origin.
y The Y coordinate of the origin.
The tile or stipple will be aligned such that the upper left corner of the tile or stipple will coincide with this point.

void Xfc::Gdk::GCValues::set_ts_x_origin ( int  x  ) 

Set the x coordinate of the origin when using tiles or stipples with the graphics context.

Parameters:
x The X coordinate of the origin.
The tile or stipple will be aligned such that the upper left corner of the tile or stipple will coincide with this x coordinate.

void Xfc::Gdk::GCValues::set_ts_y_origin ( int  y  ) 

Set the y coordinate of the origin when using tiles or stipples with the graphics context.

Parameters:
y The Y coordinate of the origin.
The tile or stipple will be aligned such that the upper left corner of the tile or stipple will coincide with this y coordinate.

void Xfc::Gdk::GCValues::set_clip_origin ( int  x,
int  y 
)

Sets the origin of the clip mask.

Parameters:
x The X coordinate of the origin.
y The Y coordinate of the origin.
The coordinates are interpreted relative to the upper-left corner of the destination drawable of the current operation.

void Xfc::Gdk::GCValues::set_clip_x_origin ( int  x  ) 

Sets the x coordinate of the origin of the clip mask.

Parameters:
x The X coordinate of the origin.
The x coordinate is interpreted relative to the upper-left corner of the destination drawable of the current operation.

void Xfc::Gdk::GCValues::set_clip_y_origin ( int  y  ) 

Sets the y coordinate of the origin of the clip mask.

Parameters:
y The Y coordinate of the origin.
The y coordinate is interpreted relative to the upper-left corner of the destination drawable of the current operation.

void Xfc::Gdk::GCValues::set_graphics_exposures ( bool  exposures  ) 

Sets whether copying non-visible portions of a drawable using a graphics context generates exposure events for the corresponding regions of the destination drawable (see Gdk::Drawable::draw_drawable()).

Parameters:
exposures If true, exposure events will be generated.

void Xfc::Gdk::GCValues::set_line_width ( int  width  ) 

Sets the line width.

Parameters:
width The width of lines.

void Xfc::Gdk::GCValues::set_line_style ( LineStyle  style  ) 

Sets the way dashed lines are drawn.

Parameters:
style The dash-style for lines.

void Xfc::Gdk::GCValues::set_cap_style ( CapStyle  style  ) 

Sets the way the ends of lines are drawn.

Parameters:
style The manner in which the ends of lines are drawn.

void Xfc::Gdk::GCValues::set_join_style ( JoinStyle  style  ) 

Sets the way joins between lines are drawn.

Parameters:
style The manner in which lines are joined together.


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3