phoenix-firestorm/indra/newview/lltoolbarview.h

/**
 * @file lltoolbarview.h
 * @author Merov Linden
 * @brief User customizable toolbar class
 *
 * $LicenseInfo:firstyear=2011&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2011, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLTOOLBARVIEW_H
#define LL_LLTOOLBARVIEW_H

#include "lluictrl.h"
#include "lltoolbar.h"
#include "llcommandmanager.h"
#include "llinventory.h"

class LLUICtrlFactory;

// Parent of all LLToolBar

class LLToolBarView : public LLUICtrl
{
public:
    // Xui structure of the toolbar panel
    struct Params : public LLInitParam::Block<Params, LLUICtrl::Params> {};

    // Note: valid children for LLToolBarView are stored in this registry
    typedef LLDefaultChildRegistry child_registry_t;

    // Xml structure of the toolbars.xml setting
    // Those live in a toolbars.xml found in the selected skin folder and in
    // the user folder for the user specific (saved) settings
    struct Toolbar : public LLInitParam::Block<Toolbar>
    {
        Mandatory<LLToolBarEnums::ButtonType>   button_display_mode;
        Multiple<LLCommandId::Params>   commands;
        Optional<LLToolBarEnums::Alignment>     button_alignment;       // <FS:Zi> Added alignment parameter
        Optional<LLToolBarEnums::LayoutStyle>   button_layout_style;    // <FS:Zi> Added layout style parameter

        Toolbar();
    };
    struct ToolbarSet : public LLInitParam::Block<ToolbarSet>
    {
        Optional<Toolbar>   left_toolbar,
                            right_toolbar,
                            bottom_toolbar;

        ToolbarSet();
    };

    // Derived methods
    virtual ~LLToolBarView();
    bool postBuild() override;
    void draw() override;

    // Toolbar view interface with the rest of the world
    // Checks if the commandId is being used somewhere in one of the toolbars, returns LLToolBarEnums::EToolBarLocation
    S32 hasCommand(const LLCommandId& commandId) const;
    S32 addCommand(const LLCommandId& commandId, LLToolBarEnums::EToolBarLocation toolbar, int rank = LLToolBar::RANK_NONE);
    S32 removeCommand(const LLCommandId& commandId, int& rank); // Sets the rank the removed command was at, RANK_NONE if not found
    S32 enableCommand(const LLCommandId& commandId, bool enabled);
    S32 stopCommandInProgress(const LLCommandId& commandId);
    S32 flashCommand(const LLCommandId& commandId, bool flash, bool force_flashing = false);

    // Loads the toolbars from the existing user or default settings
    bool loadToolbars(bool force_default = false);  // return false if load fails

    // Clears all buttons off the toolbars
    bool clearToolbars();

    void setToolBarsVisible(bool visible);

    static bool loadDefaultToolbars();
    static bool clearAllToolbars();

    static void startDragTool(S32 x, S32 y, LLToolBarButton* toolbarButton);
    static bool handleDragTool(S32 x, S32 y, const LLUUID& uuid, LLAssetType::EType type);
    static bool handleDropTool(void* cargo_data, EDragAndDropType cargo_type, S32 x, S32 y, LLToolBar* toolbar);
    static void resetDragTool(LLToolBarButton* toolbarButton);
    LLInventoryObject* getDragItem();
    LLView* getBottomToolbar() { return mBottomToolbarPanel; }
    LLToolBar* getToolbar(LLToolBarEnums::EToolBarLocation toolbar) { return mToolbars[toolbar]; }
    bool isModified() const;

    // <FS:Ansariel> Getters for member variables needed for console chat bottom offset
    LLView* getBottomChatStack() const { return mBottomChatStack; }
    // </FS:Ansariel>

    // <FS:Ansariel> Added to determine if toolbar gets hidden when empty
    void setHideBottomOnEmpty(bool hideBottomOnEmpty) { mHideBottomOnEmpty = hideBottomOnEmpty; }

protected:
    friend class LLUICtrlFactory;
    LLToolBarView(const Params&);

    void initFromParams(const Params&);

private:
    void    saveToolbars() const;
    bool    addCommandInternal(const LLCommandId& commandId, LLToolBar* toolbar);
    void    addToToolset(command_id_list_t& command_list, Toolbar& toolbar) const;

    static void onToolBarButtonAdded(LLView* button);
    static void onToolBarButtonRemoved(LLView* button);

    // Pointers to the toolbars handled by the toolbar view
    LLToolBar*  mToolbars[LLToolBarEnums::TOOLBAR_COUNT];
    bool        mToolbarsLoaded;

    bool                mDragStarted;
    LLToolBarButton*    mDragToolbarButton;
    LLInventoryObject*  mDragItem;
    bool                mShowToolbars;
    LLView*             mBottomToolbarPanel;

    // <FS:Ansariel> Member variables needed for console chat bottom offset
    LLView*             mBottomChatStack;
    // </FS:Ansariel>

    // <FS:Ansariel> Added to determine if toolbar gets hidden when empty
    bool                mHideBottomOnEmpty;
};

extern LLToolBarView* gToolBarView;

#endif  // LL_LLTOOLBARVIEW_H