rxvt-unicode/src/scrollbar.h

#ifndef SCROLLBAR_H
#define SCROLLBAR_H

#include <X11/Xlib.h>

struct rxvt_term;

#define R_SB_NEXT               1
#define R_SB_XTERM              2
#define R_SB_PLAIN              4
#define R_SB_RXVT               8

#define R_SB_ALIGN_CENTRE       0
#define R_SB_ALIGN_TOP          1
#define R_SB_ALIGN_BOTTOM       2

#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_IDLE = 1,
  STATE_MOTION,
  STATE_UP,
  STATE_DOWN,
};

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