/** * @file llpanel.cpp * @brief LLPanel base class * * $LicenseInfo:firstyear=2001&license=viewergpl$ * * Copyright (c) 2001-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$ */ // Opaque view with a background and a border. Can contain LLUICtrls. #include "linden_common.h" #include "llpanel.h" #include "llalertdialog.h" #include "llfocusmgr.h" #include "llfontgl.h" #include "llrect.h" #include "llerror.h" #include "lltimer.h" #include "llmenugl.h" //#include "llstatusbar.h" #include "llui.h" #include "llkeyboard.h" #include "lllineeditor.h" #include "llcontrol.h" #include "lltextbox.h" #include "lluictrl.h" #include "lluictrlfactory.h" #include "llviewborder.h" #include "llbutton.h" #include "lltabcontainer.h" static LLDefaultWidgetRegistry::Register r1("panel", &LLPanel::fromXML); const LLPanel::Params& LLPanel::getDefaultParams() { return LLUICtrlFactory::getDefaultParams(); } LLPanel::Params::Params() : has_border("border", false), bg_opaque_color("bg_opaque_color"), bg_alpha_color("bg_alpha_color"), background_visible("background_visible", false), background_opaque("background_opaque", false), min_width("min_width", 100), min_height("min_height", 100), strings("string"), filename("filename"), class_name("class") { name = "panel"; addSynonym(background_visible, "bg_visible"); addSynonym(has_border, "border_visible"); addSynonym(label, "title"); } LLPanel::LLPanel(const LLPanel::Params& p) : LLUICtrl(p), mBgColorAlpha(p.bg_alpha_color().get()), mBgColorOpaque(p.bg_opaque_color().get()), mBgVisible(p.background_visible), mBgOpaque(p.background_opaque), mDefaultBtn(NULL), mBorder(NULL), mLabel(p.label), mCommitCallbackRegistrar(false), mEnableCallbackRegistrar(false) { setIsChrome(FALSE); if (p.has_border) { addBorder(p.border); } mPanelHandle.bind(this); } // virtual BOOL LLPanel::isPanel() const { return TRUE; } void LLPanel::addBorder(LLViewBorder::Params p) { removeBorder(); p.rect = getLocalRect(); mBorder = LLUICtrlFactory::create(p); addChild( mBorder ); } void LLPanel::addBorder() { LLViewBorder::Params p; p.border_thickness(LLPANEL_BORDER_WIDTH); addBorder(p); } void LLPanel::removeBorder() { if (mBorder) { removeChild(mBorder); delete mBorder; mBorder = NULL; } } // virtual void LLPanel::clearCtrls() { LLView::ctrl_list_t ctrls = getCtrlList(); for (LLView::ctrl_list_t::iterator ctrl_it = ctrls.begin(); ctrl_it != ctrls.end(); ++ctrl_it) { LLUICtrl* ctrl = *ctrl_it; ctrl->setFocus( FALSE ); ctrl->setEnabled( FALSE ); ctrl->clear(); } } void LLPanel::setCtrlsEnabled( BOOL b ) { LLView::ctrl_list_t ctrls = getCtrlList(); for (LLView::ctrl_list_t::iterator ctrl_it = ctrls.begin(); ctrl_it != ctrls.end(); ++ctrl_it) { LLUICtrl* ctrl = *ctrl_it; ctrl->setEnabled( b ); } } void LLPanel::draw() { // draw background if( mBgVisible ) { //RN: I don't see the point of this S32 left = 0;//LLPANEL_BORDER_WIDTH; S32 top = getRect().getHeight();// - LLPANEL_BORDER_WIDTH; S32 right = getRect().getWidth();// - LLPANEL_BORDER_WIDTH; S32 bottom = 0;//LLPANEL_BORDER_WIDTH; if (mBgOpaque ) { gl_rect_2d( left, top, right, bottom, mBgColorOpaque ); } else { gl_rect_2d( left, top, right, bottom, mBgColorAlpha ); } } updateDefaultBtn(); LLView::draw(); } void LLPanel::updateDefaultBtn() { // This method does not call LLView::draw() so callers will need // to take care of that themselves at the appropriate place in // their rendering sequence if( mDefaultBtn) { if (gFocusMgr.childHasKeyboardFocus( this ) && mDefaultBtn->getEnabled()) { LLUICtrl* focus_ctrl = gFocusMgr.getKeyboardFocus(); LLButton* buttonp = dynamic_cast(focus_ctrl); BOOL focus_is_child_button = buttonp && buttonp->getCommitOnReturn(); // only enable default button when current focus is not a return-capturing button mDefaultBtn->setBorderEnabled(!focus_is_child_button); } else { mDefaultBtn->setBorderEnabled(FALSE); } } } void LLPanel::refresh() { // do nothing by default // but is automatically called in setFocus(TRUE) } void LLPanel::setDefaultBtn(LLButton* btn) { if (mDefaultBtn && mDefaultBtn->getEnabled()) { mDefaultBtn->setBorderEnabled(FALSE); } mDefaultBtn = btn; if (mDefaultBtn) { mDefaultBtn->setBorderEnabled(TRUE); } } void LLPanel::setDefaultBtn(const std::string& id) { LLButton *button = getChild(id); if (button) { setDefaultBtn(button); } else { setDefaultBtn(NULL); } } BOOL LLPanel::handleKeyHere( KEY key, MASK mask ) { BOOL handled = FALSE; LLUICtrl* cur_focus = gFocusMgr.getKeyboardFocus(); // handle user hitting ESC to defocus if (key == KEY_ESCAPE) { gFocusMgr.setKeyboardFocus(NULL); return TRUE; } else if( (mask == MASK_SHIFT) && (KEY_TAB == key)) { //SHIFT-TAB if (cur_focus) { LLUICtrl* focus_root = cur_focus->findRootMostFocusRoot(); if (focus_root) { handled = focus_root->focusPrevItem(FALSE); } } } else if( (mask == MASK_NONE ) && (KEY_TAB == key)) { //TAB if (cur_focus) { LLUICtrl* focus_root = cur_focus->findRootMostFocusRoot(); if (focus_root) { handled = focus_root->focusNextItem(FALSE); } } } // If RETURN was pressed and something has focus, call onCommit() if (!handled && cur_focus && key == KEY_RETURN && mask == MASK_NONE) { LLButton* focused_button = dynamic_cast(cur_focus); if (focused_button && focused_button->getCommitOnReturn()) { // current focus is a return-capturing button, // let *that* button handle the return key handled = FALSE; } else if (mDefaultBtn && mDefaultBtn->getVisible() && mDefaultBtn->getEnabled()) { // If we have a default button, click it when return is pressed mDefaultBtn->onCommit(); handled = TRUE; } else if (cur_focus->acceptsTextInput()) { // call onCommit for text input handling control cur_focus->onCommit(); handled = TRUE; } } return handled; } BOOL LLPanel::checkRequirements() { if (!mRequirementsError.empty()) { LLSD args; args["COMPONENTS"] = mRequirementsError; args["FLOATER"] = getName(); llwarns << getName() << " failed requirements check on: \n" << mRequirementsError << llendl; LLNotifications::instance().add(LLNotification::Params("FailedRequirementsCheck").payload(args)); mRequirementsError.clear(); return FALSE; } return TRUE; } void LLPanel::setFocus(BOOL b) { if( b ) { if (!gFocusMgr.childHasKeyboardFocus(this)) { // give ourselves focus preemptively, to avoid infinite loop LLUICtrl::setFocus(TRUE); // then try to pass to first valid child focusFirstItem(); } } else { if( this == gFocusMgr.getKeyboardFocus() ) { gFocusMgr.setKeyboardFocus( NULL ); } else { //RN: why is this here? LLView::ctrl_list_t ctrls = getCtrlList(); for (LLView::ctrl_list_t::iterator ctrl_it = ctrls.begin(); ctrl_it != ctrls.end(); ++ctrl_it) { LLUICtrl* ctrl = *ctrl_it; ctrl->setFocus( FALSE ); } } } } void LLPanel::setBorderVisible(BOOL b) { if (mBorder) { mBorder->setVisible( b ); } } LLFastTimer::DeclareTimer FTM_PANEL_CONSTRUCTION("Panel Construction"); LLView* LLPanel::fromXML(LLXMLNodePtr node, LLView* parent, LLXMLNodePtr output_node) { std::string name("panel"); node->getAttributeString("name", name); std::string class_attr; node->getAttributeString("class", class_attr); LLPanel* panelp = NULL; { LLFastTimer timer(FTM_PANEL_CONSTRUCTION); if(!class_attr.empty()) { panelp = LLRegisterPanelClass::instance().createPanelClass(class_attr); if (!panelp) { llwarns << "Panel class \"" << class_attr << "\" not registered." << llendl; } } if (!panelp) { panelp = LLUICtrlFactory::getInstance()->createFactoryPanel(name); } } // factory panels may have registered their own factory maps if (!panelp->getFactoryMap().empty()) { LLUICtrlFactory::instance().pushFactoryFunctions(&panelp->getFactoryMap()); } // for local registry callbacks; define in constructor, referenced in XUI or postBuild panelp->mCommitCallbackRegistrar.pushScope(); panelp->mEnableCallbackRegistrar.pushScope(); panelp->initPanelXML(node, parent, output_node); panelp->mCommitCallbackRegistrar.popScope(); panelp->mEnableCallbackRegistrar.popScope(); if (panelp && !panelp->getFactoryMap().empty()) { LLUICtrlFactory::instance().popFactoryFunctions(); } return panelp; } void LLPanel::initFromParams(const LLPanel::Params& p) { // control_name, tab_stop, focus_lost_callback, initial_value, rect, enabled, visible LLUICtrl::initFromParams(p); for (LLInitParam::ParamIterator::const_iterator it = p.strings().begin(); it != p.strings().end(); ++it) { mUIStrings[it->name] = it->text; } setName(p.name()); setLabel(p.label()); setShape(p.rect); parseFollowsFlags(p); setEnabled(p.enabled); setVisible(p.visible); setToolTip(p.tool_tip()); setSaveToXML(p.serializable); mHoverCursor = getCursorFromString(p.hover_cursor); if (p.has_border) { addBorder(p.border); } // let constructors set this value if not provided if (p.use_bounding_rect.isProvided()) { setUseBoundingRect(p.use_bounding_rect); } setDefaultTabGroup(p.default_tab_group); setMouseOpaque(p.mouse_opaque); setBackgroundVisible(p.background_visible); setBackgroundOpaque(p.background_opaque); setBackgroundColor(p.bg_opaque_color().get()); setTransparentColor(p.bg_alpha_color().get()); } static LLFastTimer::DeclareTimer FTM_PANEL_SETUP("Panel Setup"); static LLFastTimer::DeclareTimer FTM_EXTERNAL_PANEL_LOAD("Load Extern Panel Reference"); static LLFastTimer::DeclareTimer FTM_PANEL_POSTBUILD("Panel PostBuild"); BOOL LLPanel::initPanelXML(LLXMLNodePtr node, LLView *parent, LLXMLNodePtr output_node) { const LLPanel::Params& default_params(LLUICtrlFactory::getDefaultParams()); Params params(default_params); { LLFastTimer timer(FTM_PANEL_SETUP); LLXMLNodePtr referenced_xml; std::string xml_filename; node->getAttributeString("filename", xml_filename); if (!xml_filename.empty()) { LLFastTimer timer(FTM_EXTERNAL_PANEL_LOAD); if (output_node) { //if we are exporting, we want to export the current xml //not the referenced xml LLXUIParser::instance().readXUI(node, params); Params output_params(params); setupParamsForExport(output_params, parent); output_node->setName(node->getName()->mString); LLXUIParser::instance().writeXUI( output_node, output_params, &default_params); return TRUE; } if (!LLUICtrlFactory::getLayeredXMLNode(xml_filename, referenced_xml)) { llwarns << "Couldn't parse panel from: " << xml_filename << llendl; return FALSE; } LLXUIParser::instance().readXUI(referenced_xml, params); // add children using dimensions from referenced xml for consistent layout setShape(params.rect); LLUICtrlFactory::createChildren(this, referenced_xml); } LLXUIParser::instance().readXUI(node, params); if (output_node) { Params output_params(params); setupParamsForExport(output_params, parent); output_node->setName(node->getName()->mString); LLXUIParser::instance().writeXUI( output_node, output_params, &default_params); } setupParams(params, parent); { LLFastTimer timer(FTM_PANEL_CONSTRUCTION); initFromParams(params); } // add children LLUICtrlFactory::createChildren(this, node, output_node); // Connect to parent after children are built, because tab containers // do a reshape() on their child panels, which requires that the children // be built/added. JC if (parent) { S32 tab_group = params.tab_group.isProvided() ? params.tab_group() : -1; parent->addChild(this, tab_group); } { LLFastTimer timer(FTM_PANEL_POSTBUILD); postBuild(); } } return TRUE; } const widget_registry_t& LLPanel::getChildRegistry() const { // use default widget registry return LLDefaultWidgetRegistry::instance(); } bool LLPanel::hasString(const std::string& name) { return mUIStrings.find(name) != mUIStrings.end(); } std::string LLPanel::getString(const std::string& name, const LLStringUtil::format_map_t& args) const { ui_string_map_t::const_iterator found_it = mUIStrings.find(name); if (found_it != mUIStrings.end()) { // make a copy as format works in place LLUIString formatted_string = LLUIString(found_it->second); formatted_string.setArgList(args); return formatted_string.getString(); } std::string err_str("Failed to find string " + name + " in panel " + getName()); //*TODO: Translate if(LLUI::sSettingGroups["config"]->getBOOL("QAMode")) { llerrs << err_str << llendl; } else { llwarns << err_str << llendl; } return LLStringUtil::null; } std::string LLPanel::getString(const std::string& name) const { ui_string_map_t::const_iterator found_it = mUIStrings.find(name); if (found_it != mUIStrings.end()) { return found_it->second; } std::string err_str("Failed to find string " + name + " in panel " + getName()); //*TODO: Translate if(LLUI::sSettingGroups["config"]->getBOOL("QAMode")) { llerrs << err_str << llendl; } else { llwarns << err_str << llendl; } return LLStringUtil::null; } void LLPanel::childSetVisible(const std::string& id, bool visible) { LLView* child = findChild(id); if (child) { child->setVisible(visible); } } bool LLPanel::childIsVisible(const std::string& id) const { LLView* child = findChild(id); if (child) { return (bool)child->getVisible(); } return false; } void LLPanel::childSetEnabled(const std::string& id, bool enabled) { LLView* child = findChild(id); if (child) { child->setEnabled(enabled); } } void LLPanel::childSetTentative(const std::string& id, bool tentative) { LLView* child = findChild(id); if (child) { child->setTentative(tentative); } } bool LLPanel::childIsEnabled(const std::string& id) const { LLView* child = findChild(id); if (child) { return (bool)child->getEnabled(); } return false; } void LLPanel::childSetToolTip(const std::string& id, const std::string& msg) { LLView* child = findChild(id); if (child) { child->setToolTip(msg); } } void LLPanel::childSetRect(const std::string& id, const LLRect& rect) { LLView* child = findChild(id); if (child) { child->setRect(rect); } } bool LLPanel::childGetRect(const std::string& id, LLRect& rect) const { LLView* child = findChild(id); if (child) { rect = child->getRect(); return true; } return false; } void LLPanel::childSetFocus(const std::string& id, BOOL focus) { LLUICtrl* child = findChild(id); if (child) { child->setFocus(focus); } } BOOL LLPanel::childHasFocus(const std::string& id) { LLUICtrl* child = findChild(id); if (child) { return child->hasFocus(); } else { childNotFound(id); return FALSE; } } // *TODO: Deprecate; for backwards compatability only: void LLPanel::childSetCommitCallback(const std::string& id, boost::function cb, void* data) { LLUICtrl* child = findChild(id); if (child) { child->setCommitCallback(boost::bind(cb, child, data)); } } void LLPanel::childSetValidate(const std::string& id, boost::function cb) { LLUICtrl* child = findChild(id); if (child) { child->setValidateBeforeCommit(cb); } } void LLPanel::childSetColor(const std::string& id, const LLColor4& color) { LLUICtrl* child = findChild(id); if (child) { child->setColor(color); } } LLCtrlSelectionInterface* LLPanel::childGetSelectionInterface(const std::string& id) const { LLUICtrl* child = findChild(id); if (child) { return child->getSelectionInterface(); } return NULL; } LLCtrlListInterface* LLPanel::childGetListInterface(const std::string& id) const { LLUICtrl* child = findChild(id); if (child) { return child->getListInterface(); } return NULL; } LLCtrlScrollInterface* LLPanel::childGetScrollInterface(const std::string& id) const { LLUICtrl* child = findChild(id); if (child) { return child->getScrollInterface(); } return NULL; } void LLPanel::childSetValue(const std::string& id, LLSD value) { LLUICtrl* child = findChild(id); if (child) { child->setValue(value); } } LLSD LLPanel::childGetValue(const std::string& id) const { LLUICtrl* child = findChild(id); if (child) { return child->getValue(); } // Not found => return undefined return LLSD(); } BOOL LLPanel::childSetTextArg(const std::string& id, const std::string& key, const LLStringExplicit& text) { LLUICtrl* child = findChild(id); if (child) { return child->setTextArg(key, text); } return FALSE; } BOOL LLPanel::childSetLabelArg(const std::string& id, const std::string& key, const LLStringExplicit& text) { LLView* child = findChild(id); if (child) { return child->setLabelArg(key, text); } return FALSE; } BOOL LLPanel::childSetToolTipArg(const std::string& id, const std::string& key, const LLStringExplicit& text) { LLView* child = findChild(id); if (child) { return child->setToolTipArg(key, text); } return FALSE; } void LLPanel::childSetMinValue(const std::string& id, LLSD min_value) { LLUICtrl* child = findChild(id); if (child) { child->setMinValue(min_value); } } void LLPanel::childSetMaxValue(const std::string& id, LLSD max_value) { LLUICtrl* child = findChild(id); if (child) { child->setMaxValue(max_value); } } void LLPanel::childShowTab(const std::string& id, const std::string& tabname, bool visible) { LLTabContainer* child = findChild(id); if (child) { child->selectTabByName(tabname); } } LLPanel *LLPanel::childGetVisibleTab(const std::string& id) const { LLTabContainer* child = findChild(id); if (child) { return child->getCurrentPanel(); } return NULL; } void LLPanel::childSetPrevalidate(const std::string& id, BOOL (*func)(const LLWString &) ) { LLLineEditor* child = findChild(id); if (child) { child->setPrevalidate(func); } } void LLPanel::childSetWrappedText(const std::string& id, const std::string& text, bool visible) { LLTextBox* child = findChild(id); if (child) { child->setVisible(visible); child->setWrappedText(text); } } void LLPanel::childSetAction(const std::string& id, boost::function function, void* value) { LLButton* button = findChild(id); if (button) { button->setClickedCallback(boost::bind(function, value)); } } void LLPanel::childSetActionTextbox(const std::string& id, void(*function)(void*), void* value) { LLTextBox* textbox = findChild(id); if (textbox) { textbox->setClickedCallback(function, value); } } void LLPanel::childSetControlName(const std::string& id, const std::string& control_name) { LLUICtrl* view = findChild(id); if (view) { view->setControlName(control_name, NULL); } } //virtual LLView* LLPanel::getChildView(const std::string& name, BOOL recurse, BOOL create_if_missing) const { // just get child, don't try to create a dummy one LLView* view = LLUICtrl::getChildView(name, recurse, FALSE); if (!view && !recurse) { childNotFound(name); } if (!view && create_if_missing) { view = getDefaultWidget(name); if (!view) { // create LLViews explicitly, as they are not registered widget types view = LLUICtrlFactory::createDefaultWidget(name); } } return view; } void LLPanel::childNotFound(const std::string& id) const { if (mExpectedMembers.find(id) == mExpectedMembers.end()) { mNewExpectedMembers.insert(id); } } void LLPanel::childDisplayNotFound() { if (mNewExpectedMembers.empty()) { return; } std::string msg; expected_members_list_t::iterator itor; for (itor=mNewExpectedMembers.begin(); itor!=mNewExpectedMembers.end(); ++itor) { msg.append(*itor); msg.append("\n"); mExpectedMembers.insert(*itor); } mNewExpectedMembers.clear(); LLSD args; args["CONTROLS"] = msg; LLNotifications::instance().add("FloaterNotFound", args); } void LLPanel::requires(const std::string& name) { requires(name); }