summaryrefslogtreecommitdiff
path: root/indra/llui/lltabcontainer.h
blob: b72ecb8126b3b81d7885195e8a0add0076e0bd4a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/** 
 * @file lltabcontainer.h
 * @brief LLTabContainerCommon base class
 *
 * $LicenseInfo:firstyear=2001&license=viewergpl$
 * 
 * Copyright (c) 2001-2007, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlife.com/developers/opensource/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at http://secondlife.com/developers/opensource/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

// Fear my script-fu!

#ifndef LL_TABCONTAINER_H
#define LL_TABCONTAINER_H

#include "llpanel.h"
#include "llframetimer.h"

class LLButton;
class LLTextBox;


class LLTabContainerCommon : public LLPanel
{
public:
	enum TabPosition
	{
		TOP,
		BOTTOM,
		LEFT
	};
	typedef enum e_insertion_point
	{
		START,
		END,
		LEFT_OF_CURRENT,
		RIGHT_OF_CURRENT
	} eInsertionPoint;

	LLTabContainerCommon( const LLString& name, 
		const LLRect& rect,
		TabPosition pos,
		void(*close_callback)(void*), void* callback_userdata, 
		BOOL bordered = TRUE);

	LLTabContainerCommon( const LLString& name, 		
		const LLString& rect_control,
		TabPosition pos,
		void(*close_callback)(void*), void* callback_userdata, 
		BOOL bordered = TRUE);

	virtual ~LLTabContainerCommon();

	virtual void initButtons() = 0;
	
	virtual void setValue(const LLSD& value) { selectTab((S32) value.asInteger()); }
	virtual EWidgetType getWidgetType() const { return WIDGET_TYPE_TAB_CONTAINER; }
	virtual LLString getWidgetTag() const { return LL_TAB_CONTAINER_COMMON_TAG; }
	
	virtual LLView* getChildByName(const LLString& name, BOOL recurse = FALSE) const;

	static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);

	virtual void addTabPanel(LLPanel* child, 
							 const LLString& label, 
							 BOOL select = FALSE,  
							 void (*on_tab_clicked)(void*, bool) = NULL, 
							 void* userdata = NULL,
							 S32 indent = 0,
							 BOOL placeholder = FALSE,
							 eInsertionPoint insertion_point = END) = 0;
	virtual void		addPlaceholder(LLPanel* child, const LLString& label);
	virtual void		lockTabs(S32 num_tabs = 0);
	virtual void		unlockTabs();
	S32					getNumLockedTabs() { return mLockedTabCount; }

	virtual void		enableTabButton(S32 which, BOOL enable);

	virtual void removeTabPanel( LLPanel* child );
	virtual void		deleteAllTabs();
	virtual LLPanel*	getCurrentPanel();
	virtual S32			getCurrentPanelIndex();
	virtual S32			getTabCount();
	virtual S32			getPanelIndexByTitle(const LLString& title);
	virtual LLPanel*	getPanelByIndex(S32 index);
	virtual LLPanel*	getPanelByName(const LLString& name);
	virtual S32			getIndexForPanel(LLPanel* panel);

	virtual void		setCurrentTabName(const LLString& name);


	virtual void		selectFirstTab();
	virtual void		selectLastTab();
	virtual BOOL selectTabPanel( LLPanel* child );
	virtual BOOL selectTab(S32 which) = 0;
	virtual BOOL 		selectTabByName(const LLString& title);
	virtual void		selectNextTab();
	virtual void		selectPrevTab();

	BOOL        getTabPanelFlashing(LLPanel* child);
	void		setTabPanelFlashing(LLPanel* child, BOOL state);
	virtual void setTabImage(LLPanel* child, std::string img_name, const LLColor4& color = LLColor4::white);
	void		setTitle( const LLString& title );
	const LLString getPanelTitle(S32 index);

	void		setDragAndDropDelayTimer() { mDragAndDropDelayTimer.start(); }

	virtual void		setTopBorderHeight(S32 height);
	
	virtual void 		setTabChangeCallback(LLPanel* tab, void (*on_tab_clicked)(void*,bool));
	virtual void 		setTabUserData(LLPanel* tab, void* userdata);

	virtual void reshape(S32 width, S32 height, BOOL called_from_parent);

	static void	onCloseBtn(void* userdata);
	static void	onTabBtn(void* userdata);
	static void	onNextBtn(void* userdata);
	static void	onNextBtnHeld(void* userdata);
	static void	onPrevBtn(void* userdata);
	static void	onPrevBtnHeld(void* userdata);
	static void onJumpFirstBtn( void* userdata );
	static void onJumpLastBtn( void* userdata );

	virtual void		setRightTabBtnOffset( S32 offset ) { }
	virtual void		setPanelTitle(S32 index, const LLString& title) { }

	virtual TabPosition getTabPosition() { return mTabPosition; }


protected:
	// Structure used to map tab buttons to and from tab panels
	struct LLTabTuple
	{
		LLTabTuple( LLTabContainerCommon* c, LLPanel* p, LLButton* b,
					void (*cb)(void*,bool), void* userdata, LLTextBox* placeholder = NULL )
			:
			mTabContainer(c),
			mTabPanel(p),
			mButton(b),
			mOnChangeCallback( cb ),
			mUserData( userdata ),
			mOldState(FALSE),
			mPlaceholderText(placeholder),
			mPadding(0)
			{}

		LLTabContainerCommon*  mTabContainer;
		LLPanel*		 mTabPanel;
		LLButton*		 mButton;
		void			 (*mOnChangeCallback)(void*, bool);
		void*			 mUserData;
		BOOL			 mOldState;
		LLTextBox*		 mPlaceholderText;
		S32				 mPadding;
	};

	typedef std::vector<LLTabTuple*> tuple_list_t;
	tuple_list_t					mTabList;
	S32								mCurrentTabIdx;
	BOOL							mTabsHidden;

	BOOL							mScrolled;
	LLFrameTimer					mScrollTimer;
	S32								mScrollPos;
	S32								mScrollPosPixels;
	S32								mMaxScrollPos;

	LLFrameTimer					mDragAndDropDelayTimer;

	void							(*mCloseCallback)(void*);
	void*							mCallbackUserdata;

	LLTextBox*						mTitleBox;

	S32								mTopBorderHeight;
	TabPosition 					mTabPosition;
	S32								mLockedTabCount;

protected:
	void		scrollPrev();
	void		scrollNext();

	virtual void		updateMaxScrollPos() = 0;
	virtual void		commitHoveredButton(S32 x, S32 y) = 0;
	LLTabTuple* getTabByPanel(LLPanel* child);
	void insertTuple(LLTabTuple * tuple, eInsertionPoint insertion_point);
};

class LLTabContainer : public LLTabContainerCommon
{
public:
	LLTabContainer( const LLString& name, const LLRect& rect, TabPosition pos, 
		void(*close_callback)(void*), void* callback_userdata, 
					const LLString& title=LLString::null, BOOL bordered = TRUE );

	LLTabContainer( const LLString& name, const LLString& rect_control, TabPosition pos, 
		void(*close_callback)(void*), void* callback_userdata, 
					const LLString& title=LLString::null, BOOL bordered = TRUE );
	
	~LLTabContainer();

	/*virtual*/ void initButtons();

	/*virtual*/ void draw();

	/*virtual*/ void addTabPanel(LLPanel* child, 
							 const LLString& label, 
							 BOOL select = FALSE,  
							 void (*on_tab_clicked)(void*, bool) = NULL, 
							 void* userdata = NULL,
							 S32 indent = 0,
							 BOOL placeholder = FALSE,
							 eInsertionPoint insertion_point = END);

	/*virtual*/ BOOL selectTab(S32 which);
	/*virtual*/ void removeTabPanel( LLPanel* child );

	/*virtual*/ void		setPanelTitle(S32 index, const LLString& title);
	/*virtual*/ void		setTabImage(LLPanel* child, std::string img_name, const LLColor4& color = LLColor4::white);
	/*virtual*/ void		setRightTabBtnOffset( S32 offset );
	 
	/*virtual*/ void		setMinTabWidth(S32 width);
	/*virtual*/ void		setMaxTabWidth(S32 width);

	/*virtual*/ S32			getMinTabWidth() const;
	/*virtual*/ S32			getMaxTabWidth() const;

	/*virtual*/ BOOL handleMouseDown( S32 x, S32 y, MASK mask );
	/*virtual*/ BOOL handleHover( S32 x, S32 y, MASK mask );
	/*virtual*/ BOOL handleMouseUp( S32 x, S32 y, MASK mask );
	/*virtual*/ BOOL handleToolTip(S32 x, S32 y, LLString& msg, LLRect* sticky_rect );
	/*virtual*/ BOOL handleKeyHere(KEY key, MASK mask, BOOL called_from_parent);
	/*virtual*/ BOOL handleDragAndDrop(S32 x, S32 y, MASK mask,	BOOL drop,
									   EDragAndDropType type, void* cargo_data,
									   EAcceptance* accept, LLString& tooltip);

	virtual LLXMLNodePtr getXML(bool save_children = true) const;


protected:

	LLButton*						mLeftArrowBtn;
	LLButton*						mJumpLeftArrowBtn;
	LLButton*						mRightArrowBtn;
	LLButton*						mJumpRightArrowBtn;

	S32								mRightTabBtnOffset; // Extra room to the right of the tab buttons.

protected:
	virtual void	updateMaxScrollPos();
	virtual void	commitHoveredButton(S32 x, S32 y);

	S32								mMinTabWidth;
	S32								mMaxTabWidth;
	S32								mTotalTabWidth;
};

const S32 TABCNTR_CLOSE_BTN_SIZE = 16;
const S32 TABCNTR_HEADER_HEIGHT = LLPANEL_BORDER_WIDTH + TABCNTR_CLOSE_BTN_SIZE;

#endif  // LL_TABCONTAINER_H