c18b156d8b
An LLFolderView is added as child to LLScrollableContainerView, but also adds the LLScrollableContainerView to it's mScrollContainer. As a result, when scrolling inside a LLFolderView the event is passed to the mScrollContainer, which then passes it first on to it's children (see the "Bad UI design" remark in the code), causing an infinite loop. This patch breaks that loop for those objects that have a mScrollContainer: LLFolderView and LLContainerView.
347 lines
12 KiB
C++
347 lines
12 KiB
C++
/**
|
|
* @file llfolderview.h
|
|
* @brief Definition of the folder view collection of classes.
|
|
*
|
|
* $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$
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* The folder view collection of classes provides an interface for
|
|
* making a 'folder view' similar to the way the a single pane file
|
|
* folder interface works.
|
|
*
|
|
*/
|
|
|
|
#ifndef LL_LLFOLDERVIEW_H
|
|
#define LL_LLFOLDERVIEW_H
|
|
|
|
#include "llfolderviewitem.h" // because LLFolderView is-a LLFolderViewFolder
|
|
|
|
#include "lluictrl.h"
|
|
#include "v4color.h"
|
|
#include "lldarray.h"
|
|
#include "stdenums.h"
|
|
#include "lldepthstack.h"
|
|
#include "lleditmenuhandler.h"
|
|
#include "llfontgl.h"
|
|
#include "lltooldraganddrop.h"
|
|
#include "llviewertexture.h"
|
|
|
|
class LLFolderViewEventListener;
|
|
class LLFolderViewFolder;
|
|
class LLFolderViewItem;
|
|
class LLInventoryModel;
|
|
class LLPanel;
|
|
class LLLineEditor;
|
|
class LLMenuGL;
|
|
class LLScrollableContainerView;
|
|
class LLUICtrl;
|
|
class LLTextBox;
|
|
|
|
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
// Class LLFolderView
|
|
//
|
|
// The LLFolderView represents the root level folder view object.
|
|
// It manages the screen region of the folder view.
|
|
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
class LLFolderView : public LLFolderViewFolder, public LLEditMenuHandler
|
|
{
|
|
public:
|
|
typedef void (*SelectCallback)(const std::deque<LLFolderViewItem*> &items, BOOL user_action, void* data);
|
|
|
|
|
|
LLFolderView( const std::string& name, const LLRect& rect,
|
|
const LLUUID& source_id, LLPanel *parent_view, LLFolderViewEventListener* listener );
|
|
virtual ~LLFolderView( void );
|
|
|
|
virtual BOOL canFocusChildren() const;
|
|
|
|
virtual LLFolderView* getRoot() { return this; }
|
|
|
|
// FolderViews default to sort by name. This will change that,
|
|
// and resort the items if necessary.
|
|
void setSortOrder(U32 order);
|
|
void setFilterPermMask(PermissionMask filter_perm_mask);
|
|
|
|
typedef boost::signals2::signal<void (const std::deque<LLFolderViewItem*>& items, BOOL user_action)> signal_t;
|
|
void setSelectCallback(const signal_t::slot_type& cb) { mSelectSignal.connect(cb); }
|
|
void setReshapeCallback(const signal_t::slot_type& cb) { mReshapeSignal.connect(cb); }
|
|
void setAllowMultiSelect(BOOL allow) { mAllowMultiSelect = allow; }
|
|
|
|
LLInventoryFilter* getFilter();
|
|
const std::string getFilterSubString(BOOL trim = FALSE);
|
|
bool getFilterWorn() const;
|
|
U32 getFilterObjectTypes() const;
|
|
PermissionMask getFilterPermissions() const;
|
|
// *NOTE: use getFilter()->getShowFolderState();
|
|
//LLInventoryFilter::EFolderShow getShowFolderState();
|
|
U32 getSortOrder() const;
|
|
BOOL isFilterModified();
|
|
|
|
bool getAllowMultiSelect() { return mAllowMultiSelect; }
|
|
|
|
U32 toggleSearchType(std::string toggle);
|
|
U32 getSearchType() const;
|
|
|
|
// Close all folders in the view
|
|
void closeAllFolders();
|
|
void openTopLevelFolders();
|
|
|
|
virtual void toggleOpen() {};
|
|
virtual void setOpenArrangeRecursively(BOOL openitem, ERecurseType recurse);
|
|
virtual BOOL addFolder( LLFolderViewFolder* folder);
|
|
|
|
// Find width and height of this object and its children. Also
|
|
// makes sure that this view and its children are the right size.
|
|
virtual S32 arrange( S32* width, S32* height, S32 filter_generation );
|
|
|
|
void arrangeAll() { mArrangeGeneration++; }
|
|
S32 getArrangeGeneration() { return mArrangeGeneration; }
|
|
|
|
// Apply filters to control visibility of inventory items
|
|
virtual void filter( LLInventoryFilter& filter);
|
|
|
|
// Get the last selected item
|
|
virtual LLFolderViewItem* getCurSelectedItem( void );
|
|
|
|
// Record the selected item and pass it down the hierarchy.
|
|
virtual BOOL setSelection(LLFolderViewItem* selection, BOOL openitem,
|
|
BOOL take_keyboard_focus);
|
|
|
|
// Used by menu callbacks
|
|
void setSelectionByID(const LLUUID& obj_id, BOOL take_keyboard_focus);
|
|
|
|
// Called once a frame to update the selection if mSelectThisID has been set
|
|
void updateSelection();
|
|
|
|
// This method is used to toggle the selection of an item.
|
|
// Walks children and keeps track of selected objects.
|
|
virtual BOOL changeSelection(LLFolderViewItem* selection, BOOL selected);
|
|
|
|
virtual std::set<LLUUID> getSelectionList() const;
|
|
|
|
// Make sure if ancestor is selected, descendents are not
|
|
void sanitizeSelection();
|
|
void clearSelection();
|
|
void addToSelectionList(LLFolderViewItem* item);
|
|
void removeFromSelectionList(LLFolderViewItem* item);
|
|
|
|
BOOL startDrag(LLToolDragAndDrop::ESource source);
|
|
void setDragAndDropThisFrame() { mDragAndDropThisFrame = TRUE; }
|
|
void setDraggingOverItem(LLFolderViewItem* item) { mDraggingOverItem = item; }
|
|
LLFolderViewItem* getDraggingOverItem() { return mDraggingOverItem; }
|
|
|
|
// Deletion functionality
|
|
void removeSelectedItems();
|
|
static void removeCutItems();
|
|
|
|
// Open the selected item
|
|
void openSelectedItems( void );
|
|
void propertiesSelectedItems( void );
|
|
|
|
// Change the folder type
|
|
void changeType(LLInventoryModel *model, LLFolderType::EType new_folder_type);
|
|
|
|
void autoOpenItem(LLFolderViewFolder* item);
|
|
void closeAutoOpenedFolders();
|
|
BOOL autoOpenTest(LLFolderViewFolder* item);
|
|
|
|
// Copy & paste
|
|
virtual void copy();
|
|
virtual BOOL canCopy() const;
|
|
|
|
virtual void cut();
|
|
virtual BOOL canCut() const;
|
|
|
|
virtual void paste();
|
|
virtual BOOL canPaste() const;
|
|
|
|
virtual void doDelete();
|
|
virtual BOOL canDoDelete() const;
|
|
|
|
// Public rename functionality - can only start the process
|
|
void startRenamingSelectedItem( void );
|
|
|
|
// These functions were used when there was only one folderview,
|
|
// and relied on that concept. This functionality is now handled
|
|
// by the listeners and the lldraganddroptool.
|
|
//LLFolderViewItem* getMovingItem() { return mMovingItem; }
|
|
//void setMovingItem( LLFolderViewItem* item ) { mMovingItem = item; }
|
|
//void dragItemIntoFolder( LLFolderViewItem* moving_item, LLFolderViewFolder* dst_folder, BOOL drop, BOOL* accept );
|
|
//void dragFolderIntoFolder( LLFolderViewFolder* moving_folder, LLFolderViewFolder* dst_folder, BOOL drop, BOOL* accept );
|
|
|
|
// LLView functionality
|
|
///*virtual*/ BOOL handleKey( KEY key, MASK mask, BOOL called_from_parent );
|
|
/*virtual*/ BOOL handleKeyHere( KEY key, MASK mask );
|
|
/*virtual*/ BOOL handleUnicodeCharHere(llwchar uni_char);
|
|
/*virtual*/ BOOL handleMouseDown( S32 x, S32 y, MASK mask );
|
|
/*virtual*/ BOOL handleDoubleClick( S32 x, S32 y, MASK mask );
|
|
/*virtual*/ BOOL handleRightMouseDown( S32 x, S32 y, MASK mask );
|
|
/*virtual*/ BOOL handleHover( S32 x, S32 y, 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);
|
|
/*virtual*/ void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);
|
|
virtual BOOL handleScrollWheel(S32 x, S32 y, S32 clicks);
|
|
virtual void draw();
|
|
virtual void deleteAllChildren();
|
|
|
|
void scrollToShowSelection();
|
|
void scrollToShowItem(LLFolderViewItem* item, const LLRect& constraint_rect);
|
|
void setScrollContainer(LLScrollableContainerView* parent);
|
|
LLRect getVisibleRect();
|
|
|
|
BOOL search(LLFolderViewItem* first_item, const std::string &search_string, BOOL backward);
|
|
void setShowSelectionContext(BOOL show) { mShowSelectionContext = show; }
|
|
BOOL getShowSelectionContext();
|
|
void setShowSingleSelection(BOOL show);
|
|
BOOL getShowSingleSelection() { return mShowSingleSelection; }
|
|
F32 getSelectionFadeElapsedTime() { return mMultiSelectionFadeTimer.getElapsedTimeF32(); }
|
|
bool getUseEllipses() { return mUseEllipses; }
|
|
|
|
void addItemID(const LLUUID& id, LLFolderViewItem* itemp);
|
|
void removeItemID(const LLUUID& id);
|
|
LLFolderViewItem* getItemByID(const LLUUID& id);
|
|
LLFolderViewFolder* getFolderByID(const LLUUID& id);
|
|
|
|
void doIdle(); // Real idle routine
|
|
static void idle(void* user_data); // static glue to doIdle()
|
|
|
|
BOOL needsAutoSelect() { return mNeedsAutoSelect && !mAutoSelectOverride; }
|
|
BOOL needsAutoRename() { return mNeedsAutoRename; }
|
|
void setNeedsAutoRename(BOOL val) { mNeedsAutoRename = val; }
|
|
void setPinningSelectedItem(BOOL val) { mPinningSelectedItem = val; }
|
|
void setAutoSelectOverride(BOOL val) { mAutoSelectOverride = val; }
|
|
|
|
BOOL getDebugFilters() { return mDebugFilters; }
|
|
|
|
LLPanel* getParentPanel() { return mParentPanel; }
|
|
// DEBUG only
|
|
void dumpSelectionInformation();
|
|
|
|
virtual S32 notify(const LLSD& info) ;
|
|
|
|
bool useLabelSuffix() { return mUseLabelSuffix; }
|
|
void updateMenu();
|
|
|
|
private:
|
|
void updateMenuOptions(LLMenuGL* menu);
|
|
void updateRenamerPosition();
|
|
|
|
protected:
|
|
LLScrollableContainerView* mScrollContainer; // NULL if this is not a child of a scroll container.
|
|
|
|
static void commitRename( LLUICtrl* renamer, void* user_data );
|
|
void onRenamerLost();
|
|
|
|
void finishRenamingItem( void );
|
|
void closeRenamer( void );
|
|
|
|
bool selectFirstItem();
|
|
bool selectLastItem();
|
|
|
|
BOOL addNoOptions(LLMenuGL* menu) const;
|
|
protected:
|
|
LLHandle<LLView> mPopupMenuHandle;
|
|
|
|
typedef std::deque<LLFolderViewItem*> selected_items_t;
|
|
selected_items_t mSelectedItems;
|
|
BOOL mKeyboardSelection;
|
|
BOOL mAllowMultiSelect;
|
|
BOOL mShowEmptyMessage;
|
|
BOOL mShowFolderHierarchy;
|
|
LLUUID mSourceID;
|
|
|
|
// Renaming variables and methods
|
|
LLFolderViewItem* mRenameItem; // The item currently being renamed
|
|
LLLineEditor* mRenamer;
|
|
|
|
BOOL mNeedsScroll;
|
|
BOOL mPinningSelectedItem;
|
|
LLRect mScrollConstraintRect;
|
|
BOOL mNeedsAutoSelect;
|
|
BOOL mAutoSelectOverride;
|
|
BOOL mNeedsAutoRename;
|
|
bool mUseLabelSuffix;
|
|
|
|
BOOL mDebugFilters;
|
|
U32 mSortOrder;
|
|
U32 mSearchType;
|
|
LLDepthStack<LLFolderViewFolder> mAutoOpenItems;
|
|
LLFolderViewFolder* mAutoOpenCandidate;
|
|
LLFrameTimer mAutoOpenTimer;
|
|
LLFrameTimer mSearchTimer;
|
|
std::string mSearchString;
|
|
LLInventoryFilter* mFilter;
|
|
BOOL mShowSelectionContext;
|
|
BOOL mShowSingleSelection;
|
|
LLFrameTimer mMultiSelectionFadeTimer;
|
|
S32 mArrangeGeneration;
|
|
|
|
signal_t mSelectSignal;
|
|
signal_t mReshapeSignal;
|
|
S32 mSignalSelectCallback;
|
|
S32 mMinWidth;
|
|
S32 mRunningHeight;
|
|
std::map<LLUUID, LLFolderViewItem*> mItemMap;
|
|
BOOL mDragAndDropThisFrame;
|
|
|
|
LLUUID mSelectThisID; // if non null, select this item
|
|
|
|
LLPanel* mParentPanel;
|
|
|
|
/**
|
|
* Is used to determine if we need to cut text In LLFolderViewItem to avoid horizontal scroll.
|
|
* NOTE: For now it's used only to cut LLFolderViewItem::mLabel text for Landmarks in Places Panel.
|
|
*/
|
|
bool mUseEllipses; // See EXT-719
|
|
|
|
/**
|
|
* Contains item under mouse pointer while dragging
|
|
*/
|
|
LLFolderViewItem* mDraggingOverItem; // See EXT-719
|
|
|
|
public:
|
|
static F32 sAutoOpenTime;
|
|
LLTextBox* mStatusTextBox;
|
|
|
|
};
|
|
|
|
bool sort_item_name(LLFolderViewItem* a, LLFolderViewItem* b);
|
|
bool sort_item_date(LLFolderViewItem* a, LLFolderViewItem* b);
|
|
|
|
// Flags for buildContextMenu()
|
|
const U32 SUPPRESS_OPEN_ITEM = 0x1;
|
|
const U32 FIRST_SELECTED_ITEM = 0x2;
|
|
|
|
#endif // LL_LLFOLDERVIEW_H
|