phoenix-firestorm/indra/llui/llaccordionctrl.h

/** 
 * @file LLAccordionCtrl.h
 * @brief Accordion Panel implementation
 *
 * $LicenseInfo:firstyear=2004&license=viewergpl$
 * 
 * Copyright (c) 2004-2009, 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://secondlifegrid.net/programs/open_source/licensing/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://secondlifegrid.net/programs/open_source/licensing/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$
 */

#ifndef LL_ACCORDIONCTRL_H
#define LL_ACCORDIONCTRL_H

#include "llpanel.h"
#include "lltextbox.h"
#include "llscrollbar.h"

#include <vector>
#include <algorithm>
#include <string>

class LLAccordionCtrlTab;

class LLAccordionCtrl: public LLPanel
{
private:

	std::vector<LLAccordionCtrlTab*> mAccordionTabs;

	void ctrlSetLeftTopAndSize(LLView* panel, S32 left, S32 top, S32 width, S32 height);
	void ctrlShiftVertical(LLView* panel,S32 delta);
	
	void onCollapseCtrlCloseOpen(S16 panel_num); 
	void shiftAccordionTabs(S16 panel_num, S32 delta);


public:
	/**
	 * Abstract comparator for accordion tabs.
	 */
	class LLTabComparator
	{
	public:
		LLTabComparator() {};
		virtual ~LLTabComparator() {};

		/** Returns true if tab1 < tab2, false otherwise */
		virtual bool compare(const LLAccordionCtrlTab* tab1, const LLAccordionCtrlTab* tab2) const = 0;
	};

	struct Params 
		: public LLInitParam::Block<Params, LLPanel::Params>
	{
		Optional<bool>			single_expansion,
								fit_parent; /* Accordion will fit its parent size, controls that are placed into 
								accordion tabs are responsible for scrolling their content.
								*NOTE fit_parent works best when combined with single_expansion.
								Accordion view should implement getRequiredRect() and provide valid height*/
		Optional<LLTextBox::Params>	empty_accordion_text;

		Params()
			: single_expansion("single_expansion",false)
			, fit_parent("fit_parent", false)
			, empty_accordion_text("empty_accordion_text")
		{};
	};

	LLAccordionCtrl(const Params& params);

    LLAccordionCtrl();
    virtual ~LLAccordionCtrl();

	virtual BOOL postBuild();
	
	virtual BOOL handleRightMouseDown	( S32 x, S32 y, MASK mask); 
	virtual BOOL handleScrollWheel		( S32 x, S32 y, S32 clicks );
	virtual BOOL handleKeyHere			(KEY key, MASK mask);
	virtual BOOL handleDragAndDrop		(S32 x, S32 y, MASK mask, BOOL drop,
										 EDragAndDropType cargo_type,
										 void* cargo_data,
										 EAcceptance* accept,
										 std::string& tooltip_msg);
	//

	// Call reshape after changing splitter's size
	virtual void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

	void addCollapsibleCtrl(LLView* view);
	void removeCollapsibleCtrl(LLView* view);
	void arrange();


	void	draw();
	
	void	onScrollPosChangeCallback(S32, LLScrollbar*);

	void	onOpen		(const LLSD& key);
	S32		notifyParent(const LLSD& info);

	void	reset		();

	void	setComparator(const LLTabComparator* comp) { mTabComparator = comp; }
	void	sort();

	/**
	 * Sets filter substring as a search_term for help text when there are no any visible tabs.
	 */
	void	setFilterSubString(const std::string& filter_string);

	/**
	 * This method returns the first expanded accordion tab.
	 * It is expected to be called for accordion which doesn't allow multiple
	 * tabs to be expanded. Use with care.
	 */
	const LLAccordionCtrlTab* getExpandedTab() const;

private:
	void	initNoTabsWidget(const LLTextBox::Params& tb_params);
	void	updateNoTabsHelpTextVisibility();

	void	arrangeSinge();
	void	arrangeMultiple();

	// Calc Splitter's height that is necessary to display all child content
	S32		calcRecuiredHeight();
	S32		getRecuiredHeight() const { return mInnerRect.getHeight(); }
	S32		calcExpandedTabHeight(S32 tab_index = 0, S32 available_height = 0);

	void	updateLayout			(S32 width, S32 height);

	void	show_hide_scrollbar		(S32 width, S32 height);

	void	showScrollbar			(S32 width, S32 height);
	void	hideScrollbar			(S32 width, S32 height);

	BOOL	autoScroll				(S32 x, S32 y);

	/**
	 * An adaptor for LLTabComparator
	 */
	struct LLComparatorAdaptor
	{
		LLComparatorAdaptor(const LLTabComparator& comparator) : mComparator(comparator) {};

		bool operator()(const LLAccordionCtrlTab* tab1, const LLAccordionCtrlTab* tab2)
		{
			return mComparator.compare(tab1, tab2);
		}

		const LLTabComparator& mComparator;
	};

private:
	LLRect			mInnerRect;
	LLScrollbar*	mScrollbar;
	bool			mSingleExpansion;
	bool			mFitParent;
	bool			mAutoScrolling;
	F32				mAutoScrollRate;
	LLTextBox*		mNoVisibleTabsHelpText;
	std::string		mNoVisibleTabsOrigString;

	LLAccordionCtrlTab*		mSelectedTab;
	const LLTabComparator*	mTabComparator;
};


#endif // LL_LLSPLITTER_H