libs/gtkmm2/gtk/src/arrow.hg

   1 /* $Id: arrow.hg,v 1.1 2003/01/21 13:38:42 murrayc Exp $ */
   2
   3 /* arrow.h
   4  *
   5  * Copyright (C) 1998-2002 The gtkmm Development Team
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the Free
  19  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <gtkmm/misc.h>
  23 _DEFS(gtkmm,gtk)
  24 _PINCLUDE(gtkmm/private/misc_p.h)
  25
  26 namespace Gtk
  27 {
  28
  29 /** Produces an arrow pointing in one of the four cardinal directions.
  30  *
  31  * This is intended for use where a directional arrow (in one of the four
  32  * cardinal directions) is desired. As such, it has very limited
  33  * functionality and basically only draws itself in a particular direction
  34  * and with a particular shadow type.
  35  *
  36  * Gtk::Arrow will fill any space alloted to it, but since it is inherited
  37  * from Gtk::Misc, it can be padded and/or aligned, to fill exactly the
  38  * space the programmer desires.
  39  *
  40  * @ingroup Widgets
  41  */
  42 class Arrow : public Misc {
  43   _CLASS_GTKOBJECT(Arrow,GtkArrow,GTK_ARROW,Gtk::Misc,GtkMisc)
  44 public:
  45
  46
  47   /** Creates an arrow.
  48    *
  49    * @param arrow_type A Gtk::ArrowType enum describing the arrow direction.
  50    * @param shadow_type A Gtk::ShadowType enum describing the shadow type of
  51    * the arrow.
  52    */
  53   _WRAP_CTOR(Arrow(ArrowType arrow_type, ShadowType shadow_type), gtk_arrow_new)
  54
  55
  56   // Changes the direction and shadow of an arrow.
  57   _WRAP_METHOD(void set(ArrowType arrow_type, ShadowType shadow_type),gtk_arrow_set)
  58
  59   _WRAP_PROPERTY("arrow-type", ArrowType)
  60   _WRAP_PROPERTY("shadow-type", ShadowType)
  61
  62 };
  63
  64
  65 } /* namespace Gtk */
  66