rxvt-unicode/src/scrollbar.h

#ifndef SCROLLBAR_H
#define SCROLLBAR_H

#include <X11/Xlib.h>

struct rxvt_term;

#define SB_WIDTH_NEXT           19
#define SB_WIDTH_XTERM          15
#define SB_WIDTH_PLAIN          7
#ifndef SB_WIDTH_RXVT
# define SB_WIDTH_RXVT          10
#endif

/*
 * NeXT scrollbar defines
 */
#define SB_PADDING              1
#define SB_BORDER_WIDTH         1
#define SB_BEVEL_WIDTH_UPPER_LEFT       1
#define SB_BEVEL_WIDTH_LOWER_RIGHT      2
#define SB_LEFT_PADDING         (SB_PADDING + SB_BORDER_WIDTH)
#define SB_MARGIN_SPACE         (SB_PADDING * 2)
#define SB_BUTTON_WIDTH         (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
#define SB_BUTTON_HEIGHT        (SB_BUTTON_WIDTH)
#define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
#define SB_BUTTON_BOTH_HEIGHT   (SB_BUTTON_SINGLE_HEIGHT * 2)
#define SB_BUTTON_TOTAL_HEIGHT  (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
#define SB_BUTTON_BEVEL_X       (SB_LEFT_PADDING)
#define SB_BUTTON_FACE_X        (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
#define SB_THUMB_MIN_HEIGHT     (SB_BUTTON_WIDTH - (SB_PADDING * 2))

enum sb_state {
  STATE_OFF,
  STATE_IDLE,
  STATE_MOTION,
  STATE_UP,
  STATE_DOWN,
};

enum sb_style {
  R_SB_NEXT  = 1,
  R_SB_XTERM = 2,
  R_SB_PLAIN = 4,
  R_SB_RXVT  = 8,
};

enum sb_align {
  R_SB_ALIGN_CENTRE,
  R_SB_ALIGN_TOP,
  R_SB_ALIGN_BOTTOM,
};

struct scrollBar_t
{
  rxvt_term *term;
  sb_state        state;        /* scrollbar state                          */
  char            init;         /* scrollbar has been initialised           */
  unsigned int    beg;          /* slider sub-window begin height           */
  unsigned int    end;          /* slider sub-window end height             */
  unsigned int    top;          /* slider top position                      */
  unsigned int    bot;          /* slider bottom position                   */
  sb_style        style;        /* style: rxvt, xterm, next                 */
  unsigned int    width;        /* scrollbar width                          */
  int             shadow;       /* scrollbar shadow width                   */
  int             last_bot;     /* scrollbar last bottom position           */
  int             last_top;     /* scrollbar last top position              */
  int             last_state;   /* scrollbar last state                     */
  sb_align        align;
  Window          win;
  Cursor          leftptr_cursor;
  int             (scrollBar_t::*update)(int);
  void setup (rxvt_term *);
  void resize ();
  int map (int);
  int show (int);
  void destroy ();

  bool upButton (int y)
  {
    if (style == R_SB_NEXT)
      return y > end && y <= end + width + 1;
    if (style == R_SB_RXVT)
      return y < beg;
    return false;
  }
  bool dnButton (int y)
  {
    if (style == R_SB_NEXT)
      return y > end + width + 1;
    if (style == R_SB_RXVT)
      return y > end;
    return false;
  }
  unsigned min_height ()
  {
    return style == R_SB_NEXT ? SB_THUMB_MIN_HEIGHT : 10;
  }
  unsigned size ()
  {
    return end - beg - min_height ();
  }
  unsigned total_width ()
  {
    return width + shadow * 2;
  }

#if defined(NEXT_SCROLLBAR)
  GC              blackGC,
                  whiteGC,
                  grayGC,
                  darkGC,
                  stippleGC;
  Pixmap          dimple,
                  upArrow,
                  downArrow,
                  upArrowHi,
                  downArrowHi;
#endif

#if defined(RXVT_SCROLLBAR)
  GC              scrollbarGC,
                  topShadowGC,
                  botShadowGC;
#endif

#if defined(XTERM_SCROLLBAR)
  GC              xscrollbarGC,
                  ShadowGC;
#endif

#if defined(PLAIN_SCROLLBAR)
  GC              pscrollbarGC;
#endif

private:
  // update style dependent data
  void update_data ();

  // scrollbar-next.C
  int show_next (int);
  // scrollbar-rxvt.C
  int show_rxvt (int);
  // scrollbar-xterm.C
  int show_xterm (int);
  // scrollbar-plain.C
  int show_plain (int);

  void init_next ();
};

#define scrollbar_above_slider(y)       ((y) < scrollBar.top)
#define scrollbar_below_slider(y)       ((y) > scrollBar.bot)
#define scrollbar_position(y)           ((y) - scrollBar.beg)

 /*
  *    +-------------+
  *    |             | <---< SB_PADDING
  *    | ::::::::::: |
  *    | ::::::::::: |
  *   '''''''''''''''''
  *   ,,,,,,,,,,,,,,,,,
  *    | ::::::::::: |
  *    | ::::::::::: |
  *    |  +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
  *    |  | :::::::: |
  *    |  V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
  *    | +---------+ |
  *    | | ......%%| |
  *    | | ......%%| |
  *    | | .. ()..%%| |
  *    | | ......%%| |
  *    | | %%%%%%%%| |
  *    | +---------+ | <.........................
  *    |             | <---< SB_PADDING         :
  *    | +---------+ | <-+..........            :---< SB_BUTTON_TOTAL_HEIGHT
  *    | | ......%%| |   |         :            :
  *    | | ../\..%%| |   |---< SB_BUTTON_HEIGHT :
  *    | | %%%%%%%%| |   |         :            :
  *    | +---------+ | <-+         :            :
  *    |             |             :            :
  *    | +---------+ | <-+         :---< SB_BUTTON_BOTH_HEIGHT
  *    | | ......%%| |   |         :            :
  *    | | ..\/..%%| |   |         :            :
  *    | | %%%%%%%%| |   |---< SB_BUTTON_SINGLE_HEIGHT
  *    | +---------+ |   |         :            :
  *    |             |   |         :            :
  *    +-------------+ <-+.........:............:
  *    ^^|_________| :
  *    ||     |      :
  *    ||     +---< SB_BUTTON_WIDTH
  *    ||            :
  *    |+------< SB_PADDING
  *    |:            :
  *    +----< SB_BORDER_WIDTH
  *     :            :
  *     :............:
  *           |
  *           +---< SB_WIDTH_NEXT
  */

#endif
Revision:	1.24
Committed:	Mon Aug 22 17:09:46 2011 UTC (12 years, 9 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.23:	+18 -13 lines
Log Message:	Use enum types for state, style and align scrollbar variables.
#	User	Rev	Content
1	ayin	1.1	#ifndef SCROLLBAR_H
2			#define SCROLLBAR_H
3
4			#include <X11/Xlib.h>
5
6			struct rxvt_term;
7
8	ayin	1.16	#define SB_WIDTH_NEXT 19
9			#define SB_WIDTH_XTERM 15
10			#define SB_WIDTH_PLAIN 7
11			#ifndef SB_WIDTH_RXVT
12			# define SB_WIDTH_RXVT 10
13			#endif
14
15			/*
16			* NeXT scrollbar defines
17			*/
18			#define SB_PADDING 1
19			#define SB_BORDER_WIDTH 1
20			#define SB_BEVEL_WIDTH_UPPER_LEFT 1
21			#define SB_BEVEL_WIDTH_LOWER_RIGHT 2
22			#define SB_LEFT_PADDING (SB_PADDING + SB_BORDER_WIDTH)
23			#define SB_MARGIN_SPACE (SB_PADDING * 2)
24			#define SB_BUTTON_WIDTH (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
25			#define SB_BUTTON_HEIGHT (SB_BUTTON_WIDTH)
26			#define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
27			#define SB_BUTTON_BOTH_HEIGHT (SB_BUTTON_SINGLE_HEIGHT * 2)
28			#define SB_BUTTON_TOTAL_HEIGHT (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
29			#define SB_BUTTON_BEVEL_X (SB_LEFT_PADDING)
30			#define SB_BUTTON_FACE_X (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
31			#define SB_THUMB_MIN_HEIGHT (SB_BUTTON_WIDTH - (SB_PADDING * 2))
32
33	ayin	1.13	enum sb_state {
34	sf-exg	1.24	STATE_OFF,
35			STATE_IDLE,
36	ayin	1.13	STATE_MOTION,
37			STATE_UP,
38			STATE_DOWN,
39			};
40
41	sf-exg	1.24	enum sb_style {
42			R_SB_NEXT = 1,
43			R_SB_XTERM = 2,
44			R_SB_PLAIN = 4,
45			R_SB_RXVT = 8,
46			};
47
48			enum sb_align {
49			R_SB_ALIGN_CENTRE,
50			R_SB_ALIGN_TOP,
51			R_SB_ALIGN_BOTTOM,
52			};
53
54	root	1.23	struct scrollBar_t
55			{
56	ayin	1.14	rxvt_term *term;
57	sf-exg	1.24	sb_state state; /* scrollbar state */
58	ayin	1.1	char init; /* scrollbar has been initialised */
59			unsigned int beg; /* slider sub-window begin height */
60			unsigned int end; /* slider sub-window end height */
61			unsigned int top; /* slider top position */
62			unsigned int bot; /* slider bottom position */
63	sf-exg	1.24	sb_style style; /* style: rxvt, xterm, next */
64	ayin	1.1	unsigned int width; /* scrollbar width */
65	ayin	1.3	int shadow; /* scrollbar shadow width */
66	ayin	1.7	int last_bot; /* scrollbar last bottom position */
67			int last_top; /* scrollbar last top position */
68			int last_state; /* scrollbar last state */
69	sf-exg	1.24	sb_align align;
70	ayin	1.1	Window win;
71	ayin	1.10	Cursor leftptr_cursor;
72	ayin	1.20	int (scrollBar_t::*update)(int);
73	ayin	1.14	void setup (rxvt_term *);
74	ayin	1.19	void resize ();
75			int map (int);
76			int show (int);
77	ayin	1.20	void destroy ();
78	ayin	1.1
79	ayin	1.12	bool upButton (int y)
80			{
81			if (style == R_SB_NEXT)
82			return y > end && y <= end + width + 1;
83			if (style == R_SB_RXVT)
84			return y < beg;
85			return false;
86			}
87			bool dnButton (int y)
88			{
89			if (style == R_SB_NEXT)
90			return y > end + width + 1;
91			if (style == R_SB_RXVT)
92			return y > end;
93			return false;
94			}
95	ayin	1.17	unsigned min_height ()
96			{
97			return style == R_SB_NEXT ? SB_THUMB_MIN_HEIGHT : 10;
98			}
99			unsigned size ()
100			{
101			return end - beg - min_height ();
102			}
103	ayin	1.15	unsigned total_width ()
104			{
105			return width + shadow * 2;
106			}
107	ayin	1.20
108			#if defined(NEXT_SCROLLBAR)
109			GC blackGC,
110			whiteGC,
111			grayGC,
112			darkGC,
113			stippleGC;
114			Pixmap dimple,
115			upArrow,
116			downArrow,
117			upArrowHi,
118			downArrowHi;
119			#endif
120
121			#if defined(RXVT_SCROLLBAR)
122			GC scrollbarGC,
123			topShadowGC,
124			botShadowGC;
125			#endif
126
127			#if defined(XTERM_SCROLLBAR)
128			GC xscrollbarGC,
129			ShadowGC;
130			#endif
131
132			#if defined(PLAIN_SCROLLBAR)
133			GC pscrollbarGC;
134			#endif
135
136	ayin	1.22	private:
137			// update style dependent data
138			void update_data ();
139
140	ayin	1.20	// scrollbar-next.C
141			int show_next (int);
142			// scrollbar-rxvt.C
143			int show_rxvt (int);
144			// scrollbar-xterm.C
145			int show_xterm (int);
146			// scrollbar-plain.C
147			int show_plain (int);
148
149			void init_next ();
150	ayin	1.11	};
151	ayin	1.1
152			#define scrollbar_above_slider(y) ((y) < scrollBar.top)
153			#define scrollbar_below_slider(y) ((y) > scrollBar.bot)
154			#define scrollbar_position(y) ((y) - scrollBar.beg)
155
156			/*
157			* +-------------+
158			* \| \| <---< SB_PADDING
159			* \| ::::::::::: \|
160			* \| ::::::::::: \|
161			* '''''''''''''''''
162			* ,,,,,,,,,,,,,,,,,
163			* \| ::::::::::: \|
164			* \| ::::::::::: \|
165			* \| +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
166			* \| \| :::::::: \|
167			* \| V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
168			* \| +---------+ \|
169			* \| \| ......%%\| \|
170			* \| \| ......%%\| \|
171			* \| \| .. ()..%%\| \|
172			* \| \| ......%%\| \|
173			* \| \| %%%%%%%%\| \|
174			* \| +---------+ \| <.........................
175			* \| \| <---< SB_PADDING :
176			* \| +---------+ \| <-+.......... :---< SB_BUTTON_TOTAL_HEIGHT
177			* \| \| ......%%\| \| \| : :
178			* \| \| ../\..%%\| \| \|---< SB_BUTTON_HEIGHT :
179			* \| \| %%%%%%%%\| \| \| : :
180			* \| +---------+ \| <-+ : :
181			* \| \| : :
182			* \| +---------+ \| <-+ :---< SB_BUTTON_BOTH_HEIGHT
183			* \| \| ......%%\| \| \| : :
184			* \| \| ..\/..%%\| \| \| : :
185			* \| \| %%%%%%%%\| \| \|---< SB_BUTTON_SINGLE_HEIGHT
186			* \| +---------+ \| \| : :
187			* \| \| \| : :
188			* +-------------+ <-+.........:............:
189			* ^^\|_________\| :
190			* \|\| \| :
191			* \|\| +---< SB_BUTTON_WIDTH
192			* \|\| :
193			* \|+------< SB_PADDING
194			* \|: :
195			* +----< SB_BORDER_WIDTH
196			* : :
197			* :............:
198			* \|
199			* +---< SB_WIDTH_NEXT
200			*/
201
202			#endif