19367b517c
Conflicts: indra/llui/lluictrl.cpp - Silly mergestuffs indra/newview/llfloatermediabrowser.cpp - deleted indra/newview/llpanellogin.cpp - updated functions went poof Compile Fixies: indra/newview/llfloaterwater.cpp - I missed a spot with notificationsutil, it seems.
266 lines
10 KiB
C++
266 lines
10 KiB
C++
/**
|
|
* @file llpanel.h
|
|
* @author James Cook, Tom Yedwab
|
|
* @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$
|
|
*/
|
|
|
|
#ifndef LL_LLPANEL_H
|
|
#define LL_LLPANEL_H
|
|
|
|
|
|
#include "llcallbackmap.h"
|
|
#include "lluictrl.h"
|
|
#include "llbutton.h"
|
|
#include "lllineeditor.h"
|
|
#include "lluiimage.h"
|
|
#include "llviewborder.h"
|
|
#include "lluistring.h"
|
|
#include "v4color.h"
|
|
#include <list>
|
|
#include <queue>
|
|
|
|
const S32 LLPANEL_BORDER_WIDTH = 1;
|
|
const BOOL BORDER_YES = TRUE;
|
|
const BOOL BORDER_NO = FALSE;
|
|
|
|
|
|
/*
|
|
* General purpose concrete view base class.
|
|
* Transparent or opaque,
|
|
* With or without border,
|
|
* Can contain LLUICtrls.
|
|
*/
|
|
class LLPanel : public LLUICtrl
|
|
{
|
|
public:
|
|
|
|
// minimal constructor for data-driven initialization
|
|
LLPanel();
|
|
LLPanel(const std::string& name);
|
|
|
|
// Position and size not saved
|
|
LLPanel(const std::string& name, const LLRect& rect, BOOL bordered = TRUE);
|
|
|
|
// Position and size are saved to rect_control
|
|
LLPanel(const std::string& name, const std::string& rect_control, BOOL bordered = TRUE);
|
|
|
|
/*virtual*/ ~LLPanel();
|
|
|
|
// LLView interface
|
|
/*virtual*/ BOOL isPanel() const;
|
|
/*virtual*/ void draw();
|
|
/*virtual*/ BOOL handleKeyHere( KEY key, MASK mask );
|
|
/*virtual*/ void handleVisibilityChange ( BOOL new_visibility );
|
|
/*virtual*/ LLXMLNodePtr getXML(bool save_children = true) const;
|
|
// Override to set not found list:
|
|
virtual LLView* getChildView(const std::string& name, BOOL recurse = TRUE, BOOL create_if_missing = TRUE) const;
|
|
|
|
// From LLFocusableElement
|
|
/*virtual*/ void setFocus( BOOL b );
|
|
virtual void setAlpha(F32 alpha);
|
|
|
|
|
|
// New virtuals
|
|
virtual void refresh(); // called in setFocus()
|
|
virtual BOOL postBuild();
|
|
virtual void clearCtrls(); // overridden in LLPanelObject and LLPanelVolume
|
|
|
|
// Border controls
|
|
void addBorder( LLViewBorder::EBevel border_bevel = LLViewBorder::BEVEL_OUT,
|
|
LLViewBorder::EStyle border_style = LLViewBorder::STYLE_LINE,
|
|
S32 border_thickness = LLPANEL_BORDER_WIDTH );
|
|
void removeBorder();
|
|
BOOL hasBorder() const { return mBorder != NULL; }
|
|
void setBorderVisible( BOOL b );
|
|
|
|
template <class T> void requires(const std::string& name)
|
|
{
|
|
// check for widget with matching type and name
|
|
if (LLView::getChild<T>(name) == NULL)
|
|
{
|
|
mRequirementsError += name + "\n";
|
|
}
|
|
}
|
|
|
|
// requires LLView by default
|
|
void requires(const std::string& name)
|
|
{
|
|
requires<LLView>(name);
|
|
}
|
|
BOOL checkRequirements();
|
|
|
|
void setBackgroundColor( const LLColor4& color ) { mBgColorOpaque = color; }
|
|
const LLColor4& getBackgroundColor() const { return mBgColorOpaque; }
|
|
void setTransparentColor(const LLColor4& color) { mBgColorAlpha = color; }
|
|
const LLColor4& getTransparentColor() const { return mBgColorAlpha; }
|
|
void setBackgroundVisible( BOOL b ) { mBgVisible = b; }
|
|
BOOL isBackgroundVisible() const { return mBgVisible; }
|
|
void setBackgroundOpaque(BOOL b) { mBgOpaque = b; }
|
|
BOOL isBackgroundOpaque() const { return mBgOpaque; }
|
|
void setDefaultBtn(LLButton* btn = NULL);
|
|
void setDefaultBtn(const std::string& id);
|
|
void updateDefaultBtn();
|
|
void setLabel(const LLStringExplicit& label) { mLabel = label; }
|
|
std::string getLabel() const { return mLabel; }
|
|
|
|
void setRectControl(const std::string& rect_control) { mRectControl.assign(rect_control); }
|
|
const std::string& getRectControl() const { return mRectControl; }
|
|
void storeRectControl();
|
|
|
|
void setCtrlsEnabled(BOOL b);
|
|
|
|
LLHandle<LLPanel> getHandle() const { return getDerivedHandle<LLPanel>(); }
|
|
|
|
const LLCallbackMap::map_t& getFactoryMap() const { return mFactoryMap; }
|
|
|
|
CommitCallbackRegistry::ScopedRegistrar& getCommitCallbackRegistrar() { return mCommitCallbackRegistrar; }
|
|
EnableCallbackRegistry::ScopedRegistrar& getEnableCallbackRegistrar() { return mEnableCallbackRegistrar; }
|
|
virtual BOOL initPanelXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
|
|
void initChildrenXML(LLXMLNodePtr node, LLUICtrlFactory* factory);
|
|
void setPanelParameters(LLXMLNodePtr node, LLView *parentp);
|
|
|
|
bool hasString(const std::string& name);
|
|
std::string getString(const std::string& name, const LLStringUtil::format_map_t& args) const;
|
|
std::string getString(const std::string& name) const;
|
|
|
|
// ** Wrappers for setting child properties by name ** -TomY
|
|
|
|
// LLView
|
|
void childSetVisible(const std::string& name, bool visible);
|
|
void childShow(const std::string& name) { childSetVisible(name, true); }
|
|
void childHide(const std::string& name) { childSetVisible(name, false); }
|
|
bool childIsVisible(const std::string& id) const;
|
|
void childSetTentative(const std::string& name, bool tentative);
|
|
|
|
void childSetEnabled(const std::string& name, bool enabled);
|
|
void childEnable(const std::string& name) { childSetEnabled(name, true); }
|
|
void childDisable(const std::string& name) { childSetEnabled(name, false); };
|
|
bool childIsEnabled(const std::string& id) const;
|
|
|
|
void childSetToolTip(const std::string& id, const std::string& msg);
|
|
void childSetRect(const std::string& id, const LLRect &rect);
|
|
bool childGetRect(const std::string& id, LLRect& rect) const;
|
|
|
|
// LLUICtrl
|
|
void childSetFocus(const std::string& id, BOOL focus = TRUE);
|
|
BOOL childHasFocus(const std::string& id);
|
|
|
|
// *TODO: Deprecate; for backwards compatability only:
|
|
// Prefer getChild<LLUICtrl>("foo")->setCommitCallback(boost:bind(...)),
|
|
// which takes a generic slot. Or use mCommitCallbackRegistrar.add() with
|
|
// a named callback and reference it in XML.
|
|
void childSetCommitCallback(const std::string& id, boost::function<void (LLUICtrl*,void*)> cb, void* data = NULL);
|
|
|
|
void childSetValidate(const std::string& id, boost::function<bool (const LLSD& data)> cb );
|
|
|
|
void childSetColor(const std::string& id, const LLColor4& color);
|
|
void childSetAlpha(const std::string& id, F32 alpha);
|
|
|
|
LLCtrlSelectionInterface* childGetSelectionInterface(const std::string& id) const;
|
|
LLCtrlListInterface* childGetListInterface(const std::string& id) const;
|
|
LLCtrlScrollInterface* childGetScrollInterface(const std::string& id) const;
|
|
|
|
// This is the magic bullet for data-driven UI
|
|
void childSetValue(const std::string& id, LLSD value);
|
|
LLSD childGetValue(const std::string& id) const;
|
|
|
|
// For setting text / label replacement params, e.g. "Hello [NAME]"
|
|
// Not implemented for all types, defaults to noop, returns FALSE if not applicaple
|
|
BOOL childSetTextArg(const std::string& id, const std::string& key, const LLStringExplicit& text);
|
|
BOOL childSetLabelArg(const std::string& id, const std::string& key, const LLStringExplicit& text);
|
|
BOOL childSetToolTipArg(const std::string& id, const std::string& key, const LLStringExplicit& text);
|
|
|
|
// LLSlider / LLMultiSlider / LLSpinCtrl
|
|
void childSetMinValue(const std::string& id, LLSD min_value);
|
|
void childSetMaxValue(const std::string& id, LLSD max_value);
|
|
|
|
// LLTabContainer
|
|
void childShowTab(const std::string& id, const std::string& tabname, bool visible = true);
|
|
LLPanel *childGetVisibleTab(const std::string& id) const;
|
|
|
|
// LLTextBox
|
|
void childSetWrappedText(const std::string& id, const std::string& text, bool visible = true);
|
|
|
|
// LLTextBox/LLTextEditor/LLLineEditor
|
|
void childSetText(const std::string& id, const LLStringExplicit& text) { childSetValue(id, LLSD(text)); }
|
|
std::string childGetText(const std::string& id) const { return childGetValue(id).asString(); }
|
|
|
|
// LLButton
|
|
void childSetAction(const std::string& id, boost::function<void(void*)> function, void* value);
|
|
void childSetAction(const std::string& id, const commit_signal_t::slot_type& function);
|
|
|
|
// LLTextBox
|
|
void childSetActionTextbox(const std::string& id, boost::function<void(void*)> function, void* value = NULL);
|
|
|
|
void childSetControlName(const std::string& id, const std::string& control_name);
|
|
|
|
// Error reporting
|
|
void childNotFound(const std::string& id) const;
|
|
void childDisplayNotFound();
|
|
|
|
static LLView* fromXML(LLXMLNodePtr node, LLView *parent, LLUICtrlFactory *factory);
|
|
|
|
boost::signals2::connection setVisibleCallback( const commit_signal_t::slot_type& cb );
|
|
protected:
|
|
// Override to set not found list
|
|
LLButton* getDefaultButton() { return mDefaultBtn; }
|
|
LLCallbackMap::map_t mFactoryMap;
|
|
CommitCallbackRegistry::ScopedRegistrar mCommitCallbackRegistrar;
|
|
EnableCallbackRegistry::ScopedRegistrar mEnableCallbackRegistrar;
|
|
|
|
commit_signal_t* mVisibleSignal; // Called when visibility changes, passes new visibility as LLSD()
|
|
private:
|
|
// common construction logic
|
|
void init();
|
|
|
|
// Unified error reporting for the child* functions
|
|
typedef std::set<std::string> expected_members_list_t;
|
|
mutable expected_members_list_t mExpectedMembers;
|
|
mutable expected_members_list_t mNewExpectedMembers;
|
|
|
|
std::string mRectControl;
|
|
LLColor4 mBgColorAlpha;
|
|
LLColor4 mBgColorOpaque;
|
|
LLColor4 mDefaultBtnHighlight;
|
|
BOOL mBgVisible;
|
|
BOOL mBgOpaque;
|
|
LLViewBorder* mBorder;
|
|
LLButton* mDefaultBtn;
|
|
std::string mLabel;
|
|
|
|
typedef std::map<std::string, std::string> ui_string_map_t;
|
|
ui_string_map_t mUIStrings;
|
|
|
|
std::string mRequirementsError;
|
|
|
|
}; // end class LLPanel
|
|
|
|
#endif
|