Gdk::Rectangle Class Reference

#include <rectangle.h>

Public Member Functions
	Rectangle ()
	Rectangle (const GdkRectangle *gobject)
GdkRectangle *	gobj ()
	Provides access to the underlying C instance. More...
const GdkRectangle *	gobj () const
	Provides access to the underlying C instance. More...
	Rectangle (int x, int y, int width, int height)
Rectangle &	join (const Rectangle &src2)
Rectangle &	intersect (const Rectangle &src2)
Rectangle &	intersect (const Rectangle &src2, bool &rectangles_intersect)
bool	has_zero_area () const
int	get_x () const
void	set_x (const int &value)
int	get_y () const
void	set_y (const int &value)
int	get_width () const
void	set_width (const int &value)
int	get_height () const
void	set_height (const int &value)

Static Public Member Functions
static GType	get_type () G_GNUC_CONST

Protected Attributes
GdkRectangle	gobject_

Related Functions
(Note that these are not member functions.)
Gdk::Rectangle &	wrap (GdkRectangle *object)
const Gdk::Rectangle &	wrap (const GdkRectangle *object)

Detailed Description

Gdk::Rectangle is a structure holding the position and size of a rectangle. The intersection of two rectangles can be computed with intersect(). To find the union of two rectangles use union().

Definition at line 41 of file tk/ydkmm/ydkmm/rectangle.h.

Constructor & Destructor Documentation

Rectangle() [1/3]

Gdk::Rectangle::Rectangle

(

)

Rectangle() [2/3]

Gdk::Rectangle::Rectangle ( const GdkRectangle *  gobject )

explicit

Rectangle() [3/3]

Gdk::Rectangle::Rectangle	(	int	x,
		int	y,
		int	width,
		int	height
	)

Creates a new rectangle instance with these dimensions.

Member Function Documentation

get_height()

int Gdk::Rectangle::get_height

(

)

const

get_type()

static GType Gdk::Rectangle::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

get_width()

int Gdk::Rectangle::get_width

(

)

const

get_x()

int Gdk::Rectangle::get_x

(

)

const

get_y()

int Gdk::Rectangle::get_y

(

)

const

gobj() [1/2]

GdkRectangle* Gdk::Rectangle::gobj ( )

inline

Provides access to the underlying C instance.

Definition at line 58 of file tk/ydkmm/ydkmm/rectangle.h.

gobj() [2/2]

const GdkRectangle* Gdk::Rectangle::gobj ( ) const

inline

Provides access to the underlying C instance.

Definition at line 61 of file tk/ydkmm/ydkmm/rectangle.h.

has_zero_area()

bool Gdk::Rectangle::has_zero_area

(

)

const

Checks whether either the width or height are 0.

Returns

Whether this rectangle has any non-0 area.

intersect() [1/2]

Rectangle& Gdk::Rectangle::intersect

(

const Rectangle &

src2

)

Calculates the intersection of two rectangles, changing this rectangle. If the rectangles do not intersect, this rectangle's width and height is set to 0 and its x and y values are undefined.

This method returns a reference to this instance, allowing you to then call another method easily. For instance: rect.intersect(src2).join(src3);

Parameters

src2	The rectangle with which to calculate the intersection with this rectangle.

Returns

A reference to this rectangle.

intersect() [2/2]

Rectangle& Gdk::Rectangle::intersect	(	const Rectangle &	src2,
		bool &	rectangles_intersect
	)

Calculates the intersection of two rectangles, changing this rectangle. If the rectangles do not intersect, this rectangle's width and height is set to 0 and its x and y values are undefined.

This method returns a reference to this instance, allowing you to then call another method easily. For instance: rect.intersect(src2).join(src3);

Parameters

src2	The rectangle with which to calculate the intersection with this rectangle.
rectangles_intersect	This will be set to true if the rectangles intersect.

Returns

A reference to this rectangle.

join()

Rectangle& Gdk::Rectangle::join

(

const Rectangle &

src2

)

Calculates the union of two rectangles. The union of this rectangle and src2 is the smallest rectangle which includes both this rectangle and src2 within it.

This method returns a reference to this instance, allowing you to then call another method easily. For instance: rect.join(src2).intersect(src3);

Parameters

src2	The rectangle with which to calculate the union with this rectangle.

Returns

A reference to this rectangle.

set_height()

void Gdk::Rectangle::set_height

(

const int &

value

)

set_width()

void Gdk::Rectangle::set_width

(

const int &

value

)

set_x()

void Gdk::Rectangle::set_x

(

const int &

value

)

set_y()

void Gdk::Rectangle::set_y

(

const int &

value

)

Friends And Related Function Documentation

wrap() [1/2]

const Gdk::Rectangle & wrap ( const GdkRectangle *  object )

related

Parameters

object

The C instance

Returns

A C++ instance that wraps this C instance.

wrap() [2/2]

Gdk::Rectangle & wrap ( GdkRectangle *  object )

related

Parameters

object

The C instance

Returns

A C++ instance that wraps this C instance.

Member Data Documentation

gobject_

GdkRectangle Gdk::Rectangle::gobject_

protected

Definition at line 64 of file tk/ydkmm/ydkmm/rectangle.h.

---

The documentation for this class was generated from the following file:

• tk/ydkmm/ydkmm/rectangle.h