textscreen/txt_scrollpane.h

   1 // Emacs style mode select   -*- C++ -*-
   2 //-----------------------------------------------------------------------------
   3 //
   4 // Copyright(C) 2009 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_SCROLLPANE_H
  23 #define TXT_SCROLLPANE_H
  24
  25 /**
  26  * @file txt_scrollpane.h
  27  *
  28  * Scrollable pane widget.
  29  */
  30
  31 /**
  32  * Scrollable pane widget.
  33  *
  34  * A scrollable pane widget is a widget that contains another widget
  35  * that is larger than it.  Scroll bars appear on the side to allow
  36  * different areas of the contained widget to be seen.
  37  */
  38
  39 typedef struct txt_scrollpane_s txt_scrollpane_t;
  40
  41 #include "txt_widget.h"
  42
  43 struct txt_scrollpane_s
  44 {
  45     txt_widget_t widget;
  46     int w, h;
  47     int x, y;
  48     int expand_w, expand_h;
  49     txt_widget_t *child;
  50 };
  51
  52 /**
  53  * Create a new scroll pane widget.
  54  *
  55  * @param w               Width of the scroll pane, in characters.
  56  * @param h               Height of the scroll pane, in lines.
  57  * @param target          The target widget that the scroll pane will
  58  *                        contain.
  59  * @return                Pointer to the new scroll pane widget.
  60  */
  61
  62 txt_scrollpane_t *TXT_NewScrollPane(int w, int h, TXT_UNCAST_ARG(target));
  63
  64 #endif /* #ifndef TXT_SCROLLPANE_H */
  65
  66