src/gdk/Rectangle.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = gdk-Points-Rectangles-and-Regions.html
  26  * outPack = gdk
  27  * outFile = Rectangle
  28  * strct   = GdkRectangle
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = Rectangle
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gdk_rectangle_
  40  * omit structs:
  41  * omit prefixes:
  42  *      - gdk_region_
  43  * omit code:
  44  * imports:
  45  *      - gdk.Rectangle
  46  * structWrap:
  47  *      - GdkRectangle* -> Rectangle
  48  * local aliases:
  49  */
  50
  51 module gdk.Rectangle;
  52
  53 private import gdk.gdktypes;
  54
  55 private import lib.gdk;
  56
  57 private import gdk.Rectangle;
  58
  59 /**
  60  * Description
  61  * GDK provides the GdkPoint, GdkRectangle, GdkRegion and GdkSpan data types
  62  * for representing pixels and sets of pixels on the screen.
  63  * GdkPoint is a simple structure containing an x and y coordinate of a point.
  64  * GdkRectangle is a structure holding the position and size of a rectangle.
  65  * The intersection of two rectangles can be computed with
  66  * gdk_rectangle_intersect(). To find the union of two rectangles use
  67  * gdk_rectangle_union().
  68  * GdkRegion is an opaque data type holding a set of arbitrary pixels, and is
  69  * usually used for clipping graphical operations (see gdk_gc_set_clip_region()).
  70  * GdkSpan is a structure holding a spanline. A spanline is a horizontal line that
  71  * is one pixel wide. It is mainly used when rasterizing other graphics primitives.
  72  * It can be intersected to regions by using gdk_region_spans_intersect_foreach().
  73  */
  74 public class Rectangle
  75 {
  76
  77         /** the main Gtk struct */
  78         protected GdkRectangle* gdkRectangle;
  79
  80
  81         public GdkRectangle* getRectangleStruct()
  82         {
  83                 return gdkRectangle;
  84         }
  85
  86
  87         /** the main Gtk struct as a void* */
  88         protected void* getStruct()
  89         {
  90                 return cast(void*)gdkRectangle;
  91         }
  92
  93         /**
  94          * Sets our main struct and passes it to the parent class
  95          */
  96         public this (GdkRectangle* gdkRectangle)
  97         {
  98                 this.gdkRectangle = gdkRectangle;
  99         }
 100
 101         /**
 102          */
 103
 104
 105
 106         /**
 107          * Calculates the intersection of two rectangles.
 108          * It is allowed for dest to be the same as either src1 or src2.
 109          * src1:
 110          *  a GdkRectangle
 111          * src2:
 112          *  a GdkRectangle
 113          * dest:
 114          *  return location for the intersection of src1 and src2
 115          * Returns:
 116          *  TRUE if the rectangles intersect.
 117          */
 118         public int intersect(Rectangle src2, Rectangle dest)
 119         {
 120                 // gboolean gdk_rectangle_intersect (GdkRectangle *src1,  GdkRectangle *src2,  GdkRectangle *dest);
 121                 return gdk_rectangle_intersect(gdkRectangle, (src2 is null) ? null : src2.getRectangleStruct(), (dest is null) ? null : dest.getRectangleStruct());
 122         }
 123
 124         /**
 125          * Calculates the union of two rectangles.
 126          * The union of rectangles src1 and src2 is the smallest rectangle which
 127          * includes both src1 and src2 within it.
 128          * It is allowed for dest to be the same as either src1 or src2.
 129          * src1:
 130          *  a GdkRectangle
 131          * src2:
 132          *  a GdkRectangle
 133          * dest:
 134          *  return location for the union of src1 and src2
 135          */
 136         public void unio(Rectangle src2, Rectangle dest)
 137         {
 138                 // void gdk_rectangle_union (GdkRectangle *src1,  GdkRectangle *src2,  GdkRectangle *dest);
 139                 gdk_rectangle_union(gdkRectangle, (src2 is null) ? null : src2.getRectangleStruct(), (dest is null) ? null : dest.getRectangleStruct());
 140         }
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165 }