247 lines
8.9 KiB
C++
247 lines
8.9 KiB
C++
/**
|
|
* @file llcombobox.h
|
|
* @brief LLComboBox 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$
|
|
*/
|
|
|
|
// A control that displays the name of the chosen item, which when clicked
|
|
// shows a scrolling box of choices.
|
|
|
|
#ifndef LL_LLCOMBOBOX_H
|
|
#define LL_LLCOMBOBOX_H
|
|
|
|
#include "llbutton.h"
|
|
#include "lluictrl.h"
|
|
#include "llctrlselectioninterface.h"
|
|
#include "llimagegl.h"
|
|
#include "llrect.h"
|
|
|
|
// Classes
|
|
|
|
class LLFontGL;
|
|
class LLButton;
|
|
class LLSquareButton;
|
|
class LLScrollListCtrl;
|
|
class LLLineEditor;
|
|
class LLViewBorder;
|
|
|
|
extern S32 LLCOMBOBOX_HEIGHT;
|
|
extern S32 LLCOMBOBOX_WIDTH;
|
|
|
|
class LLComboBox
|
|
: public LLUICtrl, public LLCtrlListInterface
|
|
{
|
|
public:
|
|
typedef enum e_preferred_position
|
|
{
|
|
ABOVE,
|
|
BELOW
|
|
} EPreferredPosition;
|
|
|
|
LLComboBox(
|
|
const std::string& name,
|
|
const LLRect &rect,
|
|
const std::string& label,
|
|
void (*commit_callback)(LLUICtrl*, void*) = NULL,
|
|
void *callback_userdata = NULL
|
|
);
|
|
virtual ~LLComboBox();
|
|
|
|
// LLView interface
|
|
|
|
virtual LLXMLNodePtr getXML(bool save_children = true) const;
|
|
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
|
|
|
|
virtual void draw();
|
|
virtual void onFocusLost();
|
|
virtual void onLostTop();
|
|
|
|
virtual void setEnabled(BOOL enabled);
|
|
|
|
virtual BOOL handleToolTip(S32 x, S32 y, std::string& msg, LLRect* sticky_rect);
|
|
virtual BOOL handleKeyHere(KEY key, MASK mask);
|
|
virtual BOOL handleUnicodeCharHere(llwchar uni_char);
|
|
|
|
// LLUICtrl interface
|
|
virtual void clear(); // select nothing
|
|
virtual void onCommit();
|
|
virtual BOOL acceptsTextInput() const { return mAllowTextEntry; }
|
|
virtual BOOL isDirty() const; // Returns TRUE if the user has modified this control.
|
|
virtual void resetDirty(); // Clear dirty state
|
|
|
|
virtual void setFocus(BOOL b);
|
|
|
|
// Allow prevalidation of text input field
|
|
void setPrevalidate( BOOL (*func)(const LLWString &) );
|
|
|
|
// Selects item by underlying LLSD value, using LLSD::asString() matching.
|
|
// For simple items, this is just the name of the label.
|
|
virtual void setValue(const LLSD& value );
|
|
|
|
// Gets underlying LLSD value for currently selected items. For simple
|
|
// items, this is just the label.
|
|
virtual LLSD getValue() const;
|
|
|
|
void setAllowTextEntry(BOOL allow, S32 max_chars = 50, BOOL make_tentative = TRUE);
|
|
void setTextEntry(const LLStringExplicit& text);
|
|
void setFocusText(BOOL b); // Sets focus to the text input area instead of the list
|
|
BOOL isTextDirty() const; // Returns TRUE if the user has modified the text input area
|
|
void resetTextDirty(); // Resets the dirty flag on the input field
|
|
|
|
LLScrollListItem* add(const std::string& name, EAddPosition pos = ADD_BOTTOM, BOOL enabled = TRUE); // add item "name" to menu
|
|
LLScrollListItem* add(const std::string& name, const LLUUID& id, EAddPosition pos = ADD_BOTTOM, BOOL enabled = TRUE);
|
|
LLScrollListItem* add(const std::string& name, void* userdata, EAddPosition pos = ADD_BOTTOM, BOOL enabled = TRUE);
|
|
LLScrollListItem* add(const std::string& name, LLSD value, EAddPosition pos = ADD_BOTTOM, BOOL enabled = TRUE);
|
|
LLScrollListItem* addSeparator(EAddPosition pos = ADD_BOTTOM);
|
|
BOOL remove( S32 index ); // remove item by index, return TRUE if found and removed
|
|
void removeall() { clearRows(); }
|
|
|
|
void sortByName(BOOL ascending = TRUE); // Sort the entries in the combobox by name
|
|
|
|
// Select current item by name using selectItemByLabel. Returns FALSE if not found.
|
|
BOOL setSimple(const LLStringExplicit& name);
|
|
// Get name of current item. Returns an empty string if not found.
|
|
const std::string getSimple() const;
|
|
// Get contents of column x of selected row
|
|
const std::string getSelectedItemLabel(S32 column = 0) const;
|
|
|
|
// Sets the label, which doesn't have to exist in the label.
|
|
// This is probably a UI abuse.
|
|
void setLabel(const LLStringExplicit& name);
|
|
|
|
BOOL remove(const std::string& name); // remove item "name", return TRUE if found and removed
|
|
|
|
BOOL setCurrentByIndex( S32 index );
|
|
S32 getCurrentIndex() const;
|
|
|
|
virtual void updateLayout();
|
|
|
|
//========================================================================
|
|
LLCtrlSelectionInterface* getSelectionInterface() { return (LLCtrlSelectionInterface*)this; };
|
|
LLCtrlListInterface* getListInterface() { return (LLCtrlListInterface*)this; };
|
|
|
|
// LLCtrlListInterface functions
|
|
// See llscrolllistctrl.h
|
|
virtual S32 getItemCount() const;
|
|
// Overwrites the default column (See LLScrollListCtrl for format)
|
|
virtual void addColumn(const LLSD& column, EAddPosition pos = ADD_BOTTOM);
|
|
virtual void clearColumns();
|
|
virtual void setColumnLabel(const std::string& column, const std::string& label);
|
|
virtual LLScrollListItem* addElement(const LLSD& value, EAddPosition pos = ADD_BOTTOM, void* userdata = NULL);
|
|
virtual LLScrollListItem* addSimpleElement(const std::string& value, EAddPosition pos = ADD_BOTTOM, const LLSD& id = LLSD());
|
|
virtual void clearRows();
|
|
virtual void sortByColumn(const std::string& name, BOOL ascending);
|
|
|
|
// LLCtrlSelectionInterface functions
|
|
virtual BOOL getCanSelect() const { return TRUE; }
|
|
virtual BOOL selectFirstItem() { return setCurrentByIndex(0); }
|
|
virtual BOOL selectNthItem( S32 index ) { return setCurrentByIndex(index); }
|
|
virtual BOOL selectItemRange( S32 first, S32 last );
|
|
virtual S32 getFirstSelectedIndex() const { return getCurrentIndex(); }
|
|
virtual BOOL setCurrentByID( const LLUUID& id );
|
|
virtual LLUUID getCurrentID() const; // LLUUID::null if no items in menu
|
|
virtual BOOL setSelectedByValue(const LLSD& value, BOOL selected);
|
|
virtual LLSD getSelectedValue();
|
|
virtual BOOL isSelected(const LLSD& value) const;
|
|
virtual BOOL operateOnSelection(EOperation op);
|
|
virtual BOOL operateOnAll(EOperation op);
|
|
|
|
//========================================================================
|
|
|
|
void* getCurrentUserdata();
|
|
|
|
void setPrearrangeCallback( void (*cb)(LLUICtrl*,void*) ) { mPrearrangeCallback = cb; }
|
|
void setTextEntryCallback( void (*cb)(LLLineEditor*, void*) ) { mTextEntryCallback = cb; }
|
|
|
|
void setButtonVisible(BOOL visible);
|
|
|
|
static void onButtonDown(void *userdata);
|
|
static void onItemSelected(LLUICtrl* item, void *userdata);
|
|
static void onTextEntry(LLLineEditor* line_editor, void* user_data);
|
|
static void onTextCommit(LLUICtrl* caller, void* user_data);
|
|
|
|
void setSuppressTentative(bool suppress);
|
|
|
|
void updateSelection();
|
|
virtual void showList();
|
|
virtual void hideList();
|
|
|
|
protected:
|
|
LLButton* mButton;
|
|
LLScrollListCtrl* mList;
|
|
EPreferredPosition mListPosition;
|
|
LLPointer<LLUIImage> mArrowImage;
|
|
std::string mLabel;
|
|
LLColor4 mListColor;
|
|
|
|
private:
|
|
S32 mButtonPadding;
|
|
LLLineEditor* mTextEntry;
|
|
BOOL mAllowTextEntry;
|
|
S32 mMaxChars;
|
|
BOOL mTextEntryTentative;
|
|
bool mSuppressTentative;
|
|
void (*mPrearrangeCallback)(LLUICtrl*,void*);
|
|
void (*mTextEntryCallback)(LLLineEditor*, void*);
|
|
};
|
|
|
|
class LLFlyoutButton : public LLComboBox
|
|
{
|
|
public:
|
|
LLFlyoutButton(
|
|
const std::string& name,
|
|
const LLRect &rect,
|
|
const std::string& label,
|
|
void (*commit_callback)(LLUICtrl*, void*) = NULL,
|
|
void *callback_userdata = NULL);
|
|
|
|
virtual void updateLayout();
|
|
virtual void draw();
|
|
virtual void setEnabled(BOOL enabled);
|
|
|
|
void setToggleState(BOOL state);
|
|
|
|
virtual LLXMLNodePtr getXML(bool save_children = true) const;
|
|
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
|
|
static void onActionButtonClick(void *userdata);
|
|
static void onSelectAction(LLUICtrl* ctrl, void *userdata);
|
|
|
|
protected:
|
|
LLButton* mActionButton;
|
|
LLPointer<LLUIImage> mActionButtonImage;
|
|
LLPointer<LLUIImage> mExpanderButtonImage;
|
|
LLPointer<LLUIImage> mActionButtonImageSelected;
|
|
LLPointer<LLUIImage> mExpanderButtonImageSelected;
|
|
LLPointer<LLUIImage> mActionButtonImageDisabled;
|
|
LLPointer<LLUIImage> mExpanderButtonImageDisabled;
|
|
BOOL mToggleState;
|
|
};
|
|
|
|
#endif
|