summaryrefslogtreecommitdiff
path: root/indra/llui/llaccordionctrl.h
blob: 2741db24e88de16471f7c8ab02f30b38f94c897c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/**
 * @file LLAccordionCtrl.h
 * @brief Accordion Panel implementation
 *
 * $LicenseInfo:firstyear=2004&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, 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_ACCORDIONCTRL_H
#define LL_ACCORDIONCTRL_H

#include "llpanel.h"
#include "lltextbox.h"
#include "llscrollbar.h"

#include <vector>
#include <algorithm>
#include <string>

class LLAccordionCtrlTab;

class LLAccordionCtrl: public LLPanel
{
private:

    std::vector<LLAccordionCtrlTab*> mAccordionTabs;

    void ctrlSetLeftTopAndSize(LLView* panel, S32 left, S32 top, S32 width, S32 height);
    void ctrlShiftVertical(LLView* panel,S32 delta);

    void onCollapseCtrlCloseOpen(S16 panel_num);
    void shiftAccordionTabs(S16 panel_num, S32 delta);


public:
    /**
     * Abstract comparator for accordion tabs.
     */
    class LLTabComparator
    {
    public:
        LLTabComparator() {};
        virtual ~LLTabComparator() {};

        /** Returns true if tab1 < tab2, false otherwise */
        virtual bool compare(const LLAccordionCtrlTab* tab1, const LLAccordionCtrlTab* tab2) const = 0;
    };

    struct Params
        : public LLInitParam::Block<Params, LLPanel::Params>
    {
        Optional<bool>          single_expansion,
                                fit_parent; /* Accordion will fit its parent size, controls that are placed into
                                accordion tabs are responsible for scrolling their content.
                                *NOTE fit_parent works best when combined with single_expansion.
                                Accordion view should implement getRequiredRect() and provide valid height*/
        Optional<LLTextBox::Params> no_matched_tabs_text;
        Optional<LLTextBox::Params> no_visible_tabs_text;

        Params()
            : single_expansion("single_expansion",false)
            , fit_parent("fit_parent", false)
            , no_matched_tabs_text("no_matched_tabs_text")
            , no_visible_tabs_text("no_visible_tabs_text")
        {};
    };

    LLAccordionCtrl(const Params& params);

    LLAccordionCtrl();
    virtual ~LLAccordionCtrl();

    virtual BOOL postBuild();

    virtual BOOL handleRightMouseDown   ( S32 x, S32 y, MASK mask);
    virtual BOOL handleScrollWheel      ( S32 x, S32 y, S32 clicks );
    virtual BOOL handleKeyHere          (KEY key, 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);
    //

    // Call reshape after changing splitter's size
    virtual void reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

    void addCollapsibleCtrl(LLView* view);
    void removeCollapsibleCtrl(LLView* view);
    void arrange();


    void    draw();

    void    onScrollPosChangeCallback(S32, LLScrollbar*);
    virtual void onUpdateScrollToChild(const LLUICtrl * cntrl);

    void    onOpen      (const LLSD& key);
    S32     notifyParent(const LLSD& info);

    void    reset       ();
    void    expandDefaultTab();

    void    setComparator(const LLTabComparator* comp) { mTabComparator = comp; }
    void    sort();

    void collapseAllTabs();

    /**
     * Sets filter substring as a search_term for help text when there are no any visible tabs.
     */
    void    setFilterSubString(const std::string& filter_string);

    /**
     * This method returns the first expanded accordion tab.
     * It is expected to be called for accordion which doesn't allow multiple
     * tabs to be expanded. Use with care.
     */
    const LLAccordionCtrlTab* getExpandedTab() const;

    LLAccordionCtrlTab* getSelectedTab() const { return mSelectedTab; }

    bool getFitParent() const {return mFitParent;}

    void setSkipScrollToChild(bool skip) { mSkipScrollToChild = skip; }

private:
    void    initNoTabsWidget(const LLTextBox::Params& tb_params);
    void    updateNoTabsHelpTextVisibility();

    void    arrangeSingle();
    void    arrangeMultiple();

    // Calc Splitter's height that is necessary to display all child content
    S32     calcRecuiredHeight();
    S32     getRecuiredHeight() const { return mInnerRect.getHeight(); }
    S32     calcExpandedTabHeight(S32 tab_index = 0, S32 available_height = 0);

    void    updateLayout            (S32 width, S32 height);

    void    show_hide_scrollbar     (S32 width, S32 height);

    void    showScrollbar           (S32 width, S32 height);
    void    hideScrollbar           (S32 width, S32 height);

    BOOL    autoScroll              (S32 x, S32 y);

    /**
     * An adaptor for LLTabComparator
     */
    struct LLComparatorAdaptor
    {
        LLComparatorAdaptor(const LLTabComparator& comparator) : mComparator(comparator) {};

        bool operator()(const LLAccordionCtrlTab* tab1, const LLAccordionCtrlTab* tab2)
        {
            return mComparator.compare(tab1, tab2);
        }

        const LLTabComparator& mComparator;
    };

private:
    LLRect          mInnerRect;
    LLScrollbar*    mScrollbar;
    bool            mSingleExpansion;
    bool            mFitParent;
    bool            mAutoScrolling;
    F32             mAutoScrollRate;
    LLTextBox*      mNoVisibleTabsHelpText;

    bool            mSkipScrollToChild;

    std::string     mNoMatchedTabsOrigString;
    std::string     mNoVisibleTabsOrigString;

    LLAccordionCtrlTab*     mSelectedTab;
    const LLTabComparator*  mTabComparator;
};


#endif // LL_LLSPLITTER_H