gtkD/src/gtk/Arrow.d

   1 /*
   2  * This file is part of gtkD.
   3  *
   4  * gtkD 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  * gtkD 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 gtkD; 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  * module aliases:
  47  * local aliases:
  48  */
  49
  50 module gtk.Arrow;
  51
  52 version(noAssert)
  53 {
  54         version(Tango)
  55         {
  56                 import tango.io.Stdout; // use the tango loging?
  57         }
  58 }
  59
  60 private import gtkc.gtktypes;
  61
  62 private import gtkc.gtk;
  63
  64
  65
  66
  67
  68
  69 /**
  70  * Description
  71  * GtkArrow should be used to draw simple arrows that need to point in
  72  * one of the four cardinal directions (up, down, left, or right). The
  73  * style of the arrow can be one of shadow in, shadow out, etched in, or
  74  * etched out. Note that these directions and style types may be
  75  * ammended in versions of Gtk to come.
  76  * GtkArrow will fill any space alloted to it, but since it is inherited
  77  * from GtkMisc, it can be padded and/or aligned, to fill exactly the
  78  * space the programmer desires.
  79  * Arrows are created with a call to gtk_arrow_new(). The direction or
  80  * style of an arrow can be changed after creation by using gtk_arrow_set().
  81  */
  82 private import gtk.Misc;
  83 public class Arrow : Misc
  84 {
  85
  86         /** the main Gtk struct */
  87         protected GtkArrow* gtkArrow;
  88
  89
  90         public GtkArrow* getArrowStruct()
  91         {
  92                 return gtkArrow;
  93         }
  94
  95
  96         /** the main Gtk struct as a void* */
  97         protected void* getStruct()
  98         {
  99                 return cast(void*)gtkArrow;
 100         }
 101
 102         /**
 103          * Sets our main struct and passes it to the parent class
 104          */
 105         public this (GtkArrow* gtkArrow)
 106         {
 107                 version(noAssert)
 108                 {
 109                         if ( gtkArrow is null )
 110                         {
 111                                 int zero = 0;
 112                                 version(Tango)
 113                                 {
 114                                         Stdout("struct gtkArrow is null on constructor").newline;
 115                                 }
 116                                 else
 117                                 {
 118                                         printf("struct gtkArrow is null on constructor");
 119                                 }
 120                                 zero = zero / zero;
 121                         }
 122                 }
 123                 else
 124                 {
 125                         assert(gtkArrow !is null, "struct gtkArrow is null on constructor");
 126                 }
 127                 super(cast(GtkMisc*)gtkArrow);
 128                 this.gtkArrow = gtkArrow;
 129         }
 130
 131         /**
 132          */
 133
 134
 135         /**
 136          * Creates a new arrow widget.
 137          * arrow_type:
 138          * a valid GtkArrowType.
 139          * shadow_type:
 140          * a valid GtkShadowType.
 141          * Returns:
 142          * the new GtkArrow widget.
 143          */
 144         public this (GtkArrowType arrowType, GtkShadowType shadowType)
 145         {
 146                 // GtkWidget* gtk_arrow_new (GtkArrowType arrow_type,  GtkShadowType shadow_type);
 147                 this(cast(GtkArrow*)gtk_arrow_new(arrowType, shadowType) );
 148         }
 149
 150         /**
 151          * Sets the direction and style of the GtkArrow, arrow.
 152          * arrow:
 153          * a widget of type GtkArrow.
 154          * arrow_type:
 155          * a valid GtkArrowType.
 156          * shadow_type:
 157          * a valid GtkShadowType.
 158          * Property Details
 159          * The "arrow-type" property
 160          *  "arrow-type" GtkArrowType : Read / Write
 161          * The direction the arrow should point.
 162          * Default value: GTK_ARROW_RIGHT
 163          */
 164         public void set(GtkArrowType arrowType, GtkShadowType shadowType)
 165         {
 166                 // void gtk_arrow_set (GtkArrow *arrow,  GtkArrowType arrow_type,  GtkShadowType shadow_type);
 167                 gtk_arrow_set(gtkArrow, arrowType, shadowType);
 168         }
 169
 170 }