summaryrefslogtreecommitdiffstats
path: root/cui/source/options/personalization.hxx
blob: d54a8edb2499c6822cd59676efb918365e2d185a (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDED_CUI_SOURCE_OPTIONS_PERSONALIZATION_HXX
#define INCLUDED_CUI_SOURCE_OPTIONS_PERSONALIZATION_HXX

#include <sfx2/tabdlg.hxx>
#include <salhelper/thread.hxx>
#include <rtl/ref.hxx>
#include <vcl/prgsbar.hxx>
#include <vector>
#include <array>
#include <atomic>

#define MAX_RESULTS 9           // Maximum number of search results
#define MAX_DEFAULT_PERSONAS 6  // Maximum number of default personas

class Edit;
class FixedText;
class FixedHyperlink;
class SearchAndParseThread;
class GetPersonaThread;

class SvxPersonalizationTabPage : public SfxTabPage
{
    using SfxTabPage::DeactivatePage;

private:
    VclPtr<RadioButton> m_pNoPersona;                  ///< Just the default look, without any bitmap
    VclPtr<RadioButton> m_pDefaultPersona;             ///< Use the built-in bitmap
    VclPtr<RadioButton> m_pOwnPersona;                 ///< Use the user-defined bitmap
    VclPtr<PushButton> m_pSelectPersona;               ///< Let the user select in the 'own' case
    VclPtr<PushButton> m_vDefaultPersonaImages[MAX_DEFAULT_PERSONAS];     ///< Buttons to show the default persona images
    VclPtr<PushButton> m_pExtensionPersonaPreview;     ///< Buttons to show the last 3 personas installed via extensions
    VclPtr<ListBox> m_pPersonaList;                    ///< The ListBox to show the list of installed personas
    OUString m_aPersonaSettings;                       ///< Header and footer images + color to be set in the settings.
    VclPtr<FixedText> m_pExtensionLabel;               ///< The "select persona installed via extensions" label
    VclPtr<FixedHyperlink> m_pAppliedThemeLabel;            ///< The label for showing applied custom theme

    std::vector<OUString> m_vDefaultPersonaSettings;
    std::vector<OUString> m_vExtensionPersonaSettings;

public:
    SvxPersonalizationTabPage( vcl::Window *pParent, const SfxItemSet &rSet );
    virtual ~SvxPersonalizationTabPage() override;
    virtual void dispose() override;

    static VclPtr<SfxTabPage> Create( TabPageParent pParent, const SfxItemSet *rSet );

    /// Apply the settings ([OK] button).
    virtual bool FillItemSet( SfxItemSet *rSet ) override;

    /// Reset to default settings ([Revert] button).
    virtual void Reset( const SfxItemSet *rSet ) override;

    void SetPersonaSettings( const OUString& );
    void CheckAppliedTheme();
    void ShowAppliedThemeLabel( const OUString& );

    /*
     * Loads the default personas from the shared personas directory
     * which resides in the shared gallery.
     * There needs to be a separate subdirectory for each default persona,
     * which includes the preview, header, and footer images.
     * And there needs to be a personas_list.txt file in the personas directory
     * which keeps the index/info of the default personas, one persona per line.
     * A line should look like this:
     * persona_slug;Persona Name;subdir/preview.jpg;subdir/header.jpg;subdir/footer.jpg;#textcolor
     * (It is recommended to keep the subdir name the same as the slug)
     * Example line:
     *  abstract;Abstract;abstract/preview.jpg;abstract/Header2.jpg;abstract/Footer2.jpg;#ffffff
     */
    void LoadDefaultImages();
    void LoadExtensionThemes();

private:
    /// Handle the Persona selection
    DECL_LINK( SelectPersona, Button*, void );

    /// When 'own' is chosen, but the Persona is not chosen yet.
    DECL_LINK( ForceSelect, Button*, void );

    /// Handle the default Persona selection
    DECL_LINK( DefaultPersona, Button*, void );

    /// Handle the Personas installed through extensions selection
    DECL_LINK( SelectInstalledPersona, ListBox&, void );
};

/** Dialog that will allow the user to choose a Persona to use. */
class SelectPersonaDialog : public weld::GenericDialogController
{
private:
    std::vector<OUString> m_vPersonaSettings;
    OUString m_aSelectedPersona;
    OUString m_aAppliedPersona;

    std::unique_ptr<weld::Entry> m_xEdit;                              ///< The input line for the search term
    std::unique_ptr<weld::Button> m_xSearchButton;                     ///< The search button
    std::unique_ptr<weld::Label> m_xProgressLabel;                     ///< The label for showing progress of search
    std::unique_ptr<weld::ComboBox> m_xCategories;                     ///< The list of categories
    std::unique_ptr<weld::Button> m_xOkButton;                         ///< The OK button
    std::unique_ptr<weld::Button> m_xCancelButton;                     ///< The Cancel button
    std::unique_ptr<weld::Button> m_vResultList[MAX_RESULTS];          ///< List of buttons to show search results
    ::rtl::Reference< SearchAndParseThread >    m_pSearchThread;
    ::rtl::Reference< GetPersonaThread >        m_pGetPersonaThread;

public:
    explicit SelectPersonaDialog(weld::Window *pParent);
    virtual ~SelectPersonaDialog() override;

    OUString GetSelectedPersona() const;
    void SetProgress( const OUString& );
    /**
     * @brief Assigns preview images to result buttons
     * @param aPreviewImage Persona preview image
     * @param sName Name of the persona
     * @param nIndex Index number of the result button
     */
    void SetImages( VirtualDevice& rPreviewImage, const OUString& sName, const sal_Int32& nIndex );
    void AddPersonaSetting( OUString const & );
    void ClearSearchResults();
    void SetAppliedPersonaSetting( OUString const & );
    const OUString& GetAppliedPersonaSetting() const;

private:
    /// Handle the Search button
    DECL_LINK( SearchPersonas, weld::Button&, void );
    /// Handle persona categories list box
    DECL_LINK( SelectCategory, weld::ComboBox&, void );
    DECL_LINK( SelectPersona, weld::Button&, void );
    DECL_LINK( ActionOK, weld::Button&, void );
    DECL_LINK( ActionCancel, weld::Button&, void );
};

class SearchAndParseThread: public salhelper::Thread
{
private:

    SelectPersonaDialog* m_pPersonaDialog;
    OUString m_aURL;
    std::atomic<bool> m_bExecute;
    bool m_bDirectURL;

    virtual ~SearchAndParseThread() override;
    virtual void execute() override;

public:

    SearchAndParseThread( SelectPersonaDialog* pDialog,
                          const OUString& rURL, bool bDirectURL );

    void StopExecution() { m_bExecute = false; }
};

class GetPersonaThread: public salhelper::Thread
{
private:

    SelectPersonaDialog* m_pPersonaDialog;
    OUString m_aSelectedPersona;
    std::atomic<bool> m_bExecute;

    virtual ~GetPersonaThread() override;
    virtual void execute() override;

public:

    GetPersonaThread( SelectPersonaDialog* pDialog,
                          const OUString& rSelectedPersona );

    void StopExecution() { m_bExecute = false; }
};

#endif // INCLUDED_CUI_SOURCE_OPTIONS_PERSONALIZATION_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */