/** * @file llsplitbutton.cpp * @brief LLSplitButton base class * * $LicenseInfo:firstyear=2009&license=viewergpl$ * * Copyright (c) 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$ */ // A control that consolidates several buttons as options #include "llviewerprecompiledheaders.h" #include "llsplitbutton.h" #include "llinitparam.h" #include "llpanel.h" #include "llfocusmgr.h" #include "llviewerwindow.h" #include "llrootview.h" S32 BUTTON_PAD = 2; //pad between buttons on an items panel static LLDefaultChildRegistry::Register<LLSplitButton> split_button("split_button"); void LLSplitButton::ArrowPositionValues::declareValues() { declare("left", LEFT); declare("right", RIGHT); } LLSplitButton::ItemParams::ItemParams() { } LLSplitButton::Params::Params() : arrow_position("arrow_position", LEFT), items("item"), arrow_button("arrow_button"), items_panel("items_panel") { } void LLSplitButton::onFocusLost() { hideButtons(); LLUICtrl::onFocusLost(); } void LLSplitButton::setFocus(BOOL b) { LLUICtrl::setFocus(b); if (b) { if (mItemsPanel && mItemsPanel->getVisible()) { mItemsPanel->setFocus(TRUE); } } } void LLSplitButton::setEnabled(BOOL enabled) { LLView::setEnabled(enabled); mArrowBtn->setEnabled(enabled); } void LLSplitButton::onArrowBtnDown() { if (!mItemsPanel->getVisible()) { showButtons(); setFocus(TRUE); if (mArrowBtn->hasMouseCapture() || mShownItem->hasMouseCapture()) { gFocusMgr.setMouseCapture(this); } } else { hideButtons(); } } void LLSplitButton::onHeldDownShownButton() { if (!mItemsPanel->getVisible()) onArrowBtnDown(); } void LLSplitButton::onItemSelected(LLUICtrl* ctrl) { if (!ctrl) return; hideButtons(); // call the callback if it exists if(!mSelectionCallback.empty()) { mSelectionCallback(this, ctrl->getName()); } gFocusMgr.setKeyboardFocus(NULL); } BOOL LLSplitButton::handleMouseUp(S32 x, S32 y, MASK mask) { gFocusMgr.setMouseCapture(NULL); if (mShownItem->parentPointInView(x, y)) { onItemSelected(mShownItem); return TRUE; } for (std::list<LLButton*>::const_iterator it = mHidenItems.begin(); it != mHidenItems.end(); ++it) { LLButton* item = *it; S32 panel_x = 0; S32 panel_y = 0; localPointToOtherView(x, y, &panel_x, &panel_y, mItemsPanel); if (item->parentPointInView(panel_x, panel_y)) { onItemSelected(item); return TRUE; } } return TRUE; } void LLSplitButton::showButtons() { mItemsPanel->setOrigin(0, getRect().getHeight()); // register ourselves as a "top" control // effectively putting us into a special draw layer gFocusMgr.setTopCtrl(this); mItemsPanel->setFocus(TRUE); //push arrow button down and show the item buttons mArrowBtn->setToggleState(TRUE); mItemsPanel->setVisible(TRUE); setUseBoundingRect(TRUE); } void LLSplitButton::hideButtons() { mItemsPanel->setVisible(FALSE); mArrowBtn->setToggleState(FALSE); setUseBoundingRect(FALSE); if(gFocusMgr.getTopCtrl() == this) { gFocusMgr.setTopCtrl(NULL); } } // protected/private LLSplitButton::LLSplitButton(const LLSplitButton::Params& p) : LLUICtrl(p), mArrowBtn(NULL), mShownItem(NULL), mItemsPanel(NULL), mArrowPosition(p.arrow_position) { LLRect rc(p.rect); LLButton::Params arrow_params = p.arrow_button; S32 arrow_width = p.arrow_button.rect.width; //Default arrow rect values for LEFT arrow position S32 arrow_left = 0; S32 arrow_right = arrow_width; S32 btn_left = arrow_width; S32 btn_right = rc.getWidth(); if (mArrowPosition == RIGHT) { arrow_left = rc.getWidth()- arrow_width; arrow_right = rc.getWidth(); btn_left = 0; btn_right = arrow_left; } arrow_params.rect(LLRect(arrow_left, rc.getHeight(), arrow_right, 0)); arrow_params.label(""); arrow_params.mouse_down_callback.function(boost::bind(&LLSplitButton::onArrowBtnDown, this)); mArrowBtn = LLUICtrlFactory::create<LLButton>(arrow_params); addChild(mArrowBtn); //a panel for hidden item buttons LLPanel::Params panel_params = p.items_panel; mItemsPanel= prepareItemsPanel(panel_params, p.items.numValidElements()); addChild(mItemsPanel); LLInitParam::ParamIterator<ItemParams>::const_iterator it = p.items().begin(); //processing shown item button mShownItem = prepareItemButton(*it); mShownItem->setHeldDownCallback(boost::bind(&LLSplitButton::onHeldDownShownButton, this)); mShownItem->setMouseUpCallback(boost::bind(&LLSplitButton::onItemSelected, this, _1)); mShownItem->setRect(LLRect(btn_left, rc.getHeight(), btn_right, 0)); addChild(mShownItem); //processing hidden item buttons S32 item_top = mItemsPanel->getRect().getHeight(); for (++it; it != p.items().end(); ++it) { LLButton* hidden_button = prepareItemButton(*it); hidden_button->setRect(LLRect(btn_left, item_top, btn_right, item_top - rc.getHeight())); hidden_button->setMouseDownCallback(boost::bind(&LLSplitButton::onItemSelected, this, _1)); mHidenItems.push_back(hidden_button); mItemsPanel->addChild(hidden_button); //calculate next button's top item_top -= (rc.getHeight() + BUTTON_PAD); } setTopLostCallback(boost::bind(&LLSplitButton::hideButtons, this)); } LLButton* LLSplitButton::prepareItemButton(LLButton::Params params) { params.label(""); params.is_toggle(false); return LLUICtrlFactory::create<LLButton>(params); } LLPanel* LLSplitButton::prepareItemsPanel(LLPanel::Params params, S32 items_count) { S32 num_hiden_btns = items_count - 1; S32 panel_height = num_hiden_btns * (getRect().getHeight() + BUTTON_PAD); params.visible(false); params.rect.width(getRect().getWidth()); params.rect.height(panel_height); return LLUICtrlFactory::create<LLPanel>(params); }