src/gtk/Arrow.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  = GtkArrow.html
  26  * outPack = gtk
  27  * outFile = Arrow
  28  * strct   = GtkArrow
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = Arrow
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gtk_arrow_
  40  *      - gtk_
  41  * omit structs:
  42  * omit prefixes:
  43  * omit code:
  44  * imports:
  45  * structWrap:
  46  * local aliases:
  47  */
  48
  49 module gtk.Arrow;
  50
  51 private import gtk.gtktypes;
  52
  53 private import lib.gtk;
  54
  55
  56 /**
  57  * Description
  58  * GtkArrow should be used to draw simple arrows that need to point in
  59  * one of the four cardinal directions (up, down, left, or right). The
  60  * style of the arrow can be one of shadow in, shadow out, etched in, or
  61  * etched out. Note that these directions and style types may be
  62  * ammended in versions of Gtk to come.
  63  * GtkArrow will fill any space alloted to it, but since it is inherited
  64  * from GtkMisc, it can be padded and/or aligned, to fill exactly the
  65  * space the programmer desires.
  66  * Arrows are created with a call to gtk_arrow_new(). The direction or
  67  * style of an arrow can be changed after creation by using gtk_arrow_set().
  68  */
  69 private import gtk.Misc;
  70 public class Arrow : Misc
  71 {
  72
  73         /** the main Gtk struct */
  74         protected GtkArrow* gtkArrow;
  75
  76
  77         public GtkArrow* getArrowStruct()
  78         {
  79                 return gtkArrow;
  80         }
  81
  82
  83         /** the main Gtk struct as a void* */
  84         protected void* getStruct()
  85         {
  86                 return cast(void*)gtkArrow;
  87         }
  88
  89         /**
  90          * Sets our main struct and passes it to the parent class
  91          */
  92         public this (GtkArrow* gtkArrow)
  93         {
  94                 super(cast(GtkMisc*)gtkArrow);
  95                 this.gtkArrow = gtkArrow;
  96         }
  97
  98         /**
  99          */
 100
 101
 102         /**
 103          * Creates a new arrow widget.
 104          * arrow_type:
 105          * a valid GtkArrowType.
 106          * shadow_type:
 107          * a valid GtkShadowType.
 108          * Returns:
 109          * the new GtkArrow widget.
 110          */
 111         public this (GtkArrowType arrowType, GtkShadowType shadowType)
 112         {
 113                 // GtkWidget* gtk_arrow_new (GtkArrowType arrow_type,  GtkShadowType shadow_type);
 114                 this(cast(GtkArrow*)gtk_arrow_new(arrowType, shadowType) );
 115         }
 116
 117         /**
 118          * Sets the direction and style of the GtkArrow, arrow.
 119          * arrow:
 120          * a widget of type GtkArrow.
 121          * arrow_type:
 122          * a valid GtkArrowType.
 123          * shadow_type:
 124          * a valid GtkShadowType.
 125          * Property Details
 126          * The "arrow-type" property
 127          *  "arrow-type" GtkArrowType : Read / Write
 128          * The direction the arrow should point.
 129          * Default value: GTK_ARROW_RIGHT
 130          */
 131         public void set(GtkArrowType arrowType, GtkShadowType shadowType)
 132         {
 133                 // void gtk_arrow_set (GtkArrow *arrow,  GtkArrowType arrow_type,  GtkShadowType shadow_type);
 134                 gtk_arrow_set(gtkArrow, arrowType, shadowType);
 135         }
 136
 137 }