Welcome to mirror list, hosted at ThFree Co, Russian Federation.

im_selection_list.h « IMUI « GUI « Source - github.com/WolfireGames/overgrowth.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e2991ecacdfaa901b8616aac77def4d9ed1c1ab5 (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
//-----------------------------------------------------------------------------
//           Name: im_selection_list.h
//      Developer: Wolfire Games LLC
//    Description: Divider types for making selection lists
//        License: Read below
//-----------------------------------------------------------------------------
//
//
//   Copyright 2022 Wolfire Games LLC
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//
//-----------------------------------------------------------------------------
#pragma once

#include <GUI/IMUI/im_support.h>
#include <GUI/IMUI/im_element.h>
#include <GUI/IMUI/im_text.h>
#include <GUI/IMUI/im_divider.h>
#include <GUI/IMUI/im_behaviors.h>

/*******************************************************************************************/
/**
 * @brief  A selection list of text elements
 *
 *
 */
class IMTextSelectionList : public IMDivider {
    IMUpdateBehavior* itemBehavior;

   public:
    FontSetup font;                     // what font to use for this selection list
    float betweenSpace;                 // how much space to put between items?
    IMMouseOverBehavior* mouseOver;     // what behaviour for mousing over?
    ContainerAlignment itemXAlignment;  // list item x alignment
    ContainerAlignment itemYAlignment;  // list item y alignment

    /*******************************************************************************************/
    /**
     * @brief  Constructor
     *
     *
     */
    IMTextSelectionList(std::string const& name,
                        FontSetup _font,
                        float _betweenSpace,
                        IMMouseOverBehavior* _mouseOver = NULL);

    IMTextSelectionList() {}

    /*******
     *
     * Angelscript factory
     *
     */
    static IMTextSelectionList* ASFactory(std::string const& _name,
                                          FontSetup _fontSetup,
                                          float _betweenSpace,
                                          IMMouseOverBehavior* _mouseOver = NULL) {
        return new IMTextSelectionList(_name, _fontSetup, _betweenSpace, _mouseOver);
    }

    /*******************************************************************************************/
    /**
     * @brief  Set’s the alignment of the list objects
     *
     * @param xAlignment horizontal alignment
     * @param yAlignment vertical alignment
     *
     */
    void setAlignment(ContainerAlignment xAlignment, ContainerAlignment yAlignment);

    /*******************************************************************************************/
    /**
     * @brief  Gets the name of the type of this element — for autonaming and debugging
     *
     * @returns name of the element type as a string
     *
     */
    std::string getElementTypeName() override {
        return "TextSelectionList";
    }

    /*******************************************************************************************/
    /**
     * @brief  Add an update behavior to each subsequent item
     *
     * @param behavior Handle to behavior in question
     *
     */
    void setItemUpdateBehaviour(IMUpdateBehavior* behavior);

    /*******************************************************************************************/
    /**
     * @brief  Add a new entry to this list
     *
     * @param name GUI name for this text
     * @param text Text to display
     * @param name Text to send as a message when this item is selected
     *
     */
    void addEntry(std::string const& name, std::string const& text, std::string const& message);
    void addEntryParam(std::string const& name, std::string const& text, std::string const& message, std::string const& param);

    /*******************************************************************************************/
    /**
     * @brief  Destructor
     *
     */
    ~IMTextSelectionList() override;
};