textscreen/txt_strut.h

   1 // Emacs style mode select   -*- C++ -*-
   2 //-----------------------------------------------------------------------------
   3 //
   4 // Copyright(C) 2006 Simon Howard
   5 //
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 // 02111-1307, USA.
  20 //
  21
  22 #ifndef TXT_STRUT_H
  23 #define TXT_STRUT_H
  24
  25 /**
  26  * @file txt_strut.h
  27  *
  28  * Strut widget.
  29  */
  30
  31 /**
  32  * Strut widget.
  33  *
  34  * A strut is a widget that takes up a fixed amount of space.  It can
  35  * be visualised as a transparent box.  Struts are used to provide
  36  * spacing between widgets.
  37  */
  38
  39 typedef struct txt_strut_s txt_strut_t;
  40
  41 #include "txt_widget.h"
  42
  43 struct txt_strut_s
  44 {
  45     txt_widget_t widget;
  46     int width;
  47     int height;
  48 };
  49
  50 /**
  51  * Create a new strut.
  52  *
  53  * @param width      Width of the strut, in characters.
  54  * @param height     Height of the strut, in characters.
  55  */
  56
  57 txt_strut_t *TXT_NewStrut(int width, int height);
  58
  59 #endif /* #ifndef TXT_STRUT_H */
  60
  61