/** * @file llfavoritesbar.cpp * @brief LLFavoritesBarCtrl class implementation * * $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$ */ #include "llviewerprecompiledheaders.h" #include "llfavoritesbar.h" #include "llbutton.h" #include "llfloaterreg.h" #include "llfocusmgr.h" #include "llinventory.h" #include "lllandmarkactions.h" #include "lltrans.h" #include "lluictrlfactory.h" #include "llmenugl.h" #include "llagent.h" #include "llclipboard.h" #include "llinventoryclipboard.h" #include "llinventorybridge.h" #include "llinventorymodel.h" #include "llfloaterworldmap.h" #include "lllandmarkactions.h" #include "llsidetray.h" #include "lltoggleablemenu.h" #include "llviewerinventory.h" #include "llviewermenu.h" #include "llviewermenu.h" static LLDefaultChildRegistry::Register r("favorites_bar"); const S32 DROP_DOWN_MENU_WIDTH = 250; /** * Helper for LLFavoriteLandmarkButton and LLFavoriteLandmarkMenuItem. * Performing requests for SLURL for given Landmark ID */ class LLSLURLGetter { public: LLSLURLGetter() : mLandmarkID(LLUUID::null) , mSLURL("(Loading...)") , mLoaded(false) {} void setLandmarkID(const LLUUID& id) { mLandmarkID = id; } const std::string& getSLURL() { if(!mLoaded) requestSLURL(); return mSLURL; } private: /** * Requests landmark data from server. */ void requestSLURL() { if (mLandmarkID.isNull()) return; LLVector3d g_pos; if(LLLandmarkActions::getLandmarkGlobalPos(mLandmarkID, g_pos)) { LLLandmarkActions::getSLURLfromPosGlobal(g_pos, boost::bind(&LLSLURLGetter::landmarkNameCallback, this, _1), false); } } void landmarkNameCallback(const std::string& name) { mSLURL = name; mLoaded = true; } LLUUID mLandmarkID; std::string mSLURL; bool mLoaded; }; /** * This class is needed to override LLButton default handleToolTip function and * show SLURL as button tooltip. * *NOTE: dzaporozhan: This is a workaround. We could set tooltips for buttons * in createButtons function but landmark data is not available when Favorites Bar is * created. Thats why we are requesting landmark data after */ class LLFavoriteLandmarkButton : public LLButton { public: BOOL handleToolTip(S32 x, S32 y, std::string& msg, LLRect* sticky_rect) { if(LLUI::sShowXUINames) { return LLButton::handleToolTip(x, y, msg, sticky_rect); } msg = mUrlGetter.getSLURL(); return TRUE; } void setLandmarkID(const LLUUID& id){ mUrlGetter.setLandmarkID(id); } protected: LLFavoriteLandmarkButton(const LLButton::Params& p) : LLButton(p) {} friend class LLUICtrlFactory; private: LLSLURLGetter mUrlGetter; }; /** * This class is needed to override LLMenuItemCallGL default handleToolTip function and * show SLURL as button tooltip. * *NOTE: dzaporozhan: This is a workaround. We could set tooltips for buttons * in showDropDownMenu function but landmark data is not available when Favorites Bar is * created. Thats why we are requesting landmark data after */ class LLFavoriteLandmarkMenuItem : public LLMenuItemCallGL { public: BOOL handleToolTip(S32 x, S32 y, std::string& msg, LLRect* sticky_rect) { if(LLUI::sShowXUINames) { return LLMenuItemCallGL::handleToolTip(x, y, msg, sticky_rect); } msg = mUrlGetter.getSLURL(); return TRUE; } void setLandmarkID(const LLUUID& id){ mUrlGetter.setLandmarkID(id); } protected: LLFavoriteLandmarkMenuItem(const LLMenuItemCallGL::Params& p) : LLMenuItemCallGL(p) {} friend class LLUICtrlFactory; private: LLSLURLGetter mUrlGetter; }; // updateButtons's helper struct LLFavoritesSort { // Sorting by creation date and name // TODO - made it customizible using gSavedSettings bool operator()(const LLViewerInventoryItem* const& a, const LLViewerInventoryItem* const& b) { time_t first_create = a->getCreationDate(); time_t second_create = b->getCreationDate(); if (first_create == second_create) { return (LLStringUtil::compareDict(a->getName(), b->getName()) < 0); } else { return (first_create > second_create); } } }; LLFavoritesBarCtrl::Params::Params() : chevron_button_tool_tip("chevron_button_tool_tip") { } LLFavoritesBarCtrl::LLFavoritesBarCtrl(const LLFavoritesBarCtrl::Params& p) : LLUICtrl(p), mFont(p.font.isProvided() ? p.font() : LLFontGL::getFontSansSerifSmall()), mPopupMenuHandle(), mInventoryItemsPopupMenuHandle(), mChevronButtonToolTip(p.chevron_button_tool_tip) { // Register callback for menus with current registrar (will be parent panel's registrar) LLUICtrl::CommitCallbackRegistry::currentRegistrar().add("Favorites.DoToSelected", boost::bind(&LLFavoritesBarCtrl::doToSelected, this, _2)); // Add this if we need to selectively enable items //LLUICtrl::EnableCallbackRegistry::currentRegistrar().add("Favorites.EnableSelected", // boost::bind(&LLFavoritesBarCtrl::enableSelected, this, _2)); gInventory.addObserver(this); } LLFavoritesBarCtrl::~LLFavoritesBarCtrl() { gInventory.removeObserver(this); LLView::deleteViewByHandle(mPopupMenuHandle); LLView::deleteViewByHandle(mInventoryItemsPopupMenuHandle); } BOOL LLFavoritesBarCtrl::handleDragAndDrop(S32 x, S32 y, MASK mask, BOOL drop, EDragAndDropType cargo_type, void* cargo_data, EAcceptance* accept, std::string& tooltip_msg) { *accept = ACCEPT_NO; switch (cargo_type) { case DAD_LANDMARK: { // Copy the item into the favorites folder (if it's not already there). LLInventoryItem *item = (LLInventoryItem *)cargo_data; LLUUID favorites_id = gInventory.findCategoryUUIDForType(LLAssetType::AT_FAVORITE); if (item->getParentUUID() == favorites_id) { llwarns << "Attemt to copy a favorite item into the same folder." << llendl; break; } *accept = ACCEPT_YES_COPY_SINGLE; if (drop) { copy_inventory_item( gAgent.getID(), item->getPermissions().getOwner(), item->getUUID(), favorites_id, std::string(), LLPointer(NULL)); llinfos << "Copied inventory item #" << item->getUUID() << " to favorites." << llendl; } } break; default: break; } return TRUE; } //virtual void LLFavoritesBarCtrl::changed(U32 mask) { if (mFavoriteFolderId.isNull()) { mFavoriteFolderId = gInventory.findCategoryUUIDForType(LLAssetType::AT_FAVORITE); if (mFavoriteFolderId.notNull()) { gInventory.fetchDescendentsOf(mFavoriteFolderId); } } else { updateButtons(getRect().getWidth()); } } //virtual void LLFavoritesBarCtrl::reshape(S32 width, S32 height, BOOL called_from_parent) { updateButtons(width); LLUICtrl::reshape(width, height, called_from_parent); } LLXMLNodePtr LLFavoritesBarCtrl::getButtonXMLNode() { LLXMLNodePtr buttonXMLNode = NULL; bool success = LLUICtrlFactory::getLayeredXMLNode("favorites_bar_button.xml", buttonXMLNode); if (!success) { llwarns << "Unable to read xml file with button for Favorites Bar: favorites_bar_button.xml" << llendl; buttonXMLNode = NULL; } return buttonXMLNode; } void LLFavoritesBarCtrl::updateButtons(U32 bar_width) { LLInventoryModel::item_array_t items; if (!collectFavoriteItems(items)) { return; } static LLXMLNodePtr buttonXMLNode = getButtonXMLNode(); if (buttonXMLNode.isNull()) { return; } S32 buttonWidth = 120; //default value buttonXMLNode->getAttributeS32("width", buttonWidth); S32 buttonHGap = 2; // default value buttonXMLNode->getAttributeS32("left", buttonHGap); const S32 buttonVGap = 2; S32 count = items.count(); const S32 buttonHPad = LLUI::sSettingGroups["config"]->getS32("ButtonHPad"); const S32 chevron_button_width = mFont->getWidth(">>") + buttonHPad * 2; S32 buttons_space = bar_width - buttonHGap; S32 first_drop_down_item = count; // Calculating, how much buttons can fit in the bar S32 buttons_width = 0; for (S32 i = 0; i < count; ++i) { buttons_width += buttonWidth + buttonHGap; if (buttons_width > buttons_space) { // There is no space for all buttons. // Calculating the number of buttons, that are fit with chevron button buttons_space -= chevron_button_width + buttonHGap; while (i >= 0 && buttons_width > buttons_space) { buttons_width -= buttonWidth + buttonHGap; i--; } first_drop_down_item = i + 1; // First item behind visible items break; } } bool recreate_buttons = true; // If inventory items are not changed up to mFirstDropDownItem, no need to recreate them if (mFirstDropDownItem == first_drop_down_item && (mItemNamesCache.size() == count || mItemNamesCache.size() == mFirstDropDownItem)) { S32 i; for (i = 0; i < mFirstDropDownItem; ++i) { if (mItemNamesCache.get(i) != items.get(i)->getName()) { break; } } if (i == mFirstDropDownItem) { recreate_buttons = false; } } if (recreate_buttons) { mFirstDropDownItem = first_drop_down_item; mItemNamesCache.clear(); for (S32 i = 0; i < mFirstDropDownItem; i++) { mItemNamesCache.put(items.get(i)->getName()); } // Rebuild the buttons only // child_list_t is a linked list, so safe to erase from the middle if we pre-incrament the iterator for ( child_list_const_iter_t child_it = getChildList()->begin(); child_it != getChildList()->end(); ) { child_list_const_iter_t cur_it = child_it++; LLView* viewp = *cur_it; LLButton* button = dynamic_cast(viewp); if (button) { removeChild(button); delete button; } } createButtons(items, buttonXMLNode, buttonWidth, buttonHGap); } // Chevron button if (mFirstDropDownItem != count) { // Chevron button should stay right aligned LLView *chevron_button = findChildView(std::string(">>"), FALSE); if (chevron_button) { LLRect rect; rect.setOriginAndSize(bar_width - chevron_button_width - buttonHGap, buttonVGap, chevron_button_width, getRect().getHeight()-buttonVGap); chevron_button->setRect(rect); chevron_button->setVisible(TRUE); mChevronRect = rect; } else { static LLButton::Params default_button_params(LLUICtrlFactory::getDefaultParams()); std::string flat_icon = "transparent.j2c"; std::string hover_icon = default_button_params.image_unselected.name; std::string hover_icon_selected = default_button_params.image_selected.name; LLButton::Params bparams; LLRect rect; rect.setOriginAndSize(bar_width - chevron_button_width - buttonHGap, buttonVGap, chevron_button_width, getRect().getHeight()-buttonVGap); bparams.follows.flags (FOLLOWS_LEFT | FOLLOWS_BOTTOM); bparams.image_unselected.name(flat_icon); bparams.image_disabled.name(flat_icon); bparams.image_selected.name(hover_icon_selected); bparams.image_hover_selected.name(hover_icon_selected); bparams.image_disabled_selected.name(hover_icon_selected); bparams.image_hover_unselected.name(hover_icon); bparams.rect (rect); bparams.tab_stop(false); bparams.font(mFont); bparams.name(">>"); bparams.tool_tip(mChevronButtonToolTip); bparams.click_callback.function(boost::bind(&LLFavoritesBarCtrl::showDropDownMenu, this)); addChildInBack(LLUICtrlFactory::create (bparams)); mChevronRect = rect; } } else { // Hide chevron button if all items are visible on bar LLView *chevron_button = findChildView(std::string(">>"), FALSE); if (chevron_button) { chevron_button->setVisible(FALSE); } } } void LLFavoritesBarCtrl::createButtons(const LLInventoryModel::item_array_t &items, const LLXMLNodePtr &buttonXMLNode, S32 buttonWidth, S32 buttonHGap) { S32 curr_x = buttonHGap; // Adding buttons for(S32 i = mFirstDropDownItem -1; i >= 0; i--) { LLInventoryItem* item = items.get(i); LLFavoriteLandmarkButton* fav_btn = LLUICtrlFactory::defaultBuilder(buttonXMLNode, this, NULL); if (NULL == fav_btn) { llwarns << "Unable to create button for landmark: " << item->getName() << llendl; continue; } fav_btn->setLandmarkID(item->getUUID()); // change only left and save bottom fav_btn->setOrigin(curr_x, fav_btn->getRect().mBottom); fav_btn->setFont(mFont); fav_btn->setName(item->getName()); fav_btn->setLabel(item->getName()); fav_btn->setToolTip(item->getName()); fav_btn->setCommitCallback(boost::bind(&LLFavoritesBarCtrl::onButtonClick, this, item->getUUID())); fav_btn->setRightMouseDownCallback(boost::bind(&LLFavoritesBarCtrl::onButtonRightClick, this, item->getUUID(), _1, _2, _3,_4 )); sendChildToBack(fav_btn); curr_x += buttonWidth + buttonHGap; } } BOOL LLFavoritesBarCtrl::postBuild() { // make the popup menu available LLMenuGL* menu = LLUICtrlFactory::getInstance()->createFromFile("menu_favorites.xml", gMenuHolder, LLViewerMenuHolderGL::child_registry_t::instance()); if (!menu) { menu = LLUICtrlFactory::getDefaultWidget("inventory_menu"); } menu->setBackgroundColor(LLUIColorTable::instance().getColor("MenuPopupBgColor")); mInventoryItemsPopupMenuHandle = menu->getHandle(); return TRUE; } BOOL LLFavoritesBarCtrl::collectFavoriteItems(LLInventoryModel::item_array_t &items) { if (mFavoriteFolderId.isNull()) return FALSE; LLInventoryModel::cat_array_t cats; LLIsType is_type(LLAssetType::AT_LANDMARK); gInventory.collectDescendentsIf(mFavoriteFolderId, cats, items, LLInventoryModel::EXCLUDE_TRASH, is_type); std::sort(items.begin(), items.end(), LLFavoritesSort()); return TRUE; } void LLFavoritesBarCtrl::showDropDownMenu() { if (mPopupMenuHandle.isDead()) { LLToggleableMenu::Params menu_p; menu_p.name("favorites menu"); menu_p.can_tear_off(false); menu_p.visible(false); menu_p.scrollable(true); menu_p.max_scrollable_items = 10; menu_p.preferred_width = DROP_DOWN_MENU_WIDTH; LLToggleableMenu* menu = LLUICtrlFactory::create(menu_p); mPopupMenuHandle = menu->getHandle(); } LLToggleableMenu* menu = (LLToggleableMenu*)mPopupMenuHandle.get(); if(menu) { if (!menu->toggleVisibility()) return; LLInventoryModel::item_array_t items; if (!collectFavoriteItems(items)) { return; } S32 count = items.count(); // Check it there are changed items, since last call if (mItemNamesCache.size() == count) { S32 i; for (i = mFirstDropDownItem; i < count; i++) { if (mItemNamesCache.get(i) != items.get(i)->getName()) { break; } } // Check passed, just show the menu if (i == count) { menu->buildDrawLabels(); menu->updateParent(LLMenuGL::sMenuContainer); menu->setButtonRect(mChevronRect, this); LLMenuGL::showPopup(this, menu, getRect().getWidth() - menu->getRect().getWidth(), 0); return; } } // Add menu items to cache, if there is only names of buttons if (mItemNamesCache.size() == mFirstDropDownItem) { for (S32 i = mFirstDropDownItem; i < count; i++) { mItemNamesCache.put(items.get(i)->getName()); } } menu->empty(); U32 max_width = llmin(DROP_DOWN_MENU_WIDTH, getRect().getWidth()); U32 widest_item = 0; for(S32 i = mFirstDropDownItem; i < count; i++) { LLInventoryItem* item = items.get(i); const std::string& item_name = item->getName(); LLMenuItemCallGL::Params item_params; item_params.name(item_name); item_params.label(item_name); item_params.on_click.function(boost::bind(&LLFavoritesBarCtrl::onButtonClick, this, item->getUUID())); LLFavoriteLandmarkMenuItem *menu_item = LLUICtrlFactory::create(item_params); menu_item->setRightMouseDownCallback(boost::bind(&LLFavoritesBarCtrl::onButtonRightClick, this,item->getUUID(),_1,_2,_3,_4)); menu_item->setLandmarkID(item->getUUID()); // Check whether item name wider than menu if (menu_item->getNominalWidth() > max_width) { S32 chars_total = item_name.length(); S32 chars_fitted = 1; menu_item->setLabel(LLStringExplicit("")); S32 label_space = max_width - menu_item->getFont()->getWidth("...") - menu_item->getNominalWidth(); // This returns width of menu item with empty label (pad pixels) while (chars_fitted < chars_total && menu_item->getFont()->getWidth(item_name, 0, chars_fitted) < label_space) { chars_fitted++; } chars_fitted--; // Rolling back one char, that doesn't fit menu_item->setLabel(item_name.substr(0, chars_fitted) + "..."); } widest_item = llmax(widest_item, menu_item->getNominalWidth()); menu->addChild(menu_item); } menu->buildDrawLabels(); menu->updateParent(LLMenuGL::sMenuContainer); menu->setButtonRect(mChevronRect, this); LLMenuGL::showPopup(this, menu, getRect().getWidth() - max_width, 0); } } void LLFavoritesBarCtrl::onButtonClick(LLUUID item_id) { LLInventoryModel::item_array_t items; if (!collectFavoriteItems(items)) { return; } // We only have one Inventory, gInventory. Some day this should be better abstracted. LLInvFVBridgeAction::doAction(item_id,&gInventory); } void LLFavoritesBarCtrl::onButtonRightClick( LLUUID item_id,LLView* fav_button,S32 x,S32 y,MASK mask) { mSelectedItemID = item_id; LLMenuGL* menu = (LLMenuGL*)mInventoryItemsPopupMenuHandle.get(); if (!menu) { return; } // Release mouse capture so hover events go to the popup menu // because this is happening during a mouse down. gFocusMgr.setMouseCapture(NULL); menu->updateParent(LLMenuGL::sMenuContainer); LLMenuGL::showPopup(fav_button, menu, x, y); } void copy_slurl_to_clipboard_cb(std::string& slurl) { gClipboard.copyFromString(utf8str_to_wstring(slurl)); } void LLFavoritesBarCtrl::doToSelected(const LLSD& userdata) { std::string action = userdata.asString(); llinfos << "Action = " << action << " Item = " << mSelectedItemID.asString() << llendl; LLViewerInventoryItem* item = gInventory.getItem(mSelectedItemID); if (!item) return; if (action == "open") { teleport_via_landmark(item->getAssetUUID()); } else if (action == "about") { LLSD key; key["type"] = "landmark"; key["id"] = mSelectedItemID; LLSideTray::getInstance()->showPanel("panel_places", key); } else if (action == "copy_slurl") { LLVector3d posGlobal; LLLandmarkActions::getLandmarkGlobalPos(mSelectedItemID, posGlobal); if (!posGlobal.isExactlyZero()) { LLLandmarkActions::getSLURLfromPosGlobal(posGlobal, copy_slurl_to_clipboard_cb); } } else if (action == "show_on_map") { LLFloaterWorldMap* worldmap_instance = LLFloaterWorldMap::getInstance(); LLVector3d posGlobal; LLLandmarkActions::getLandmarkGlobalPos(mSelectedItemID, posGlobal); if (!posGlobal.isExactlyZero() && worldmap_instance) { worldmap_instance->trackLocation(posGlobal); LLFloaterReg::showInstance("world_map", "center"); } } else if (action == "cut") { } else if (action == "copy") { LLInventoryClipboard::instance().store(mSelectedItemID); } else if (action == "paste") { pastFromClipboard(); } else if (action == "delete") { gInventory.removeItem(mSelectedItemID); } } BOOL LLFavoritesBarCtrl::isClipboardPasteable() const { if (!LLInventoryClipboard::instance().hasContents()) { return FALSE; } LLDynamicArray objects; LLInventoryClipboard::instance().retrieve(objects); S32 count = objects.count(); for(S32 i = 0; i < count; i++) { const LLUUID &item_id = objects.get(i); // Can't paste folders const LLInventoryCategory *cat = gInventory.getCategory(item_id); if (cat) { return FALSE; } const LLInventoryItem *item = gInventory.getItem(item_id); if (item && LLAssetType::AT_LANDMARK != item->getType()) { return FALSE; } } return TRUE; } void LLFavoritesBarCtrl::pastFromClipboard() const { LLInventoryModel* model = &gInventory; if(model && isClipboardPasteable()) { LLInventoryItem* item = NULL; LLDynamicArray objects; LLInventoryClipboard::instance().retrieve(objects); S32 count = objects.count(); LLUUID parent_id(mFavoriteFolderId); for(S32 i = 0; i < count; i++) { item = model->getItem(objects.get(i)); if (item) { copy_inventory_item( gAgent.getID(), item->getPermissions().getOwner(), item->getUUID(), parent_id, std::string(), LLPointer(NULL)); } } } } // EOF