summaryrefslogtreecommitdiffstats
path: root/src/ui/pref-pusher.h
blob: 0d62266c478572fd507cc43312db0a4ca555c751 (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
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SEEN_PREF_PUSHER_H
#define SEEN_PREF_PUSHER_H

#include "preferences.h"

typedef struct _GtkToggleAction GtkToggleAction;

namespace Inkscape {
namespace UI {

/**
 * A simple mediator class that keeps UI controls matched to the preference values they set.
 */
class PrefPusher : public Inkscape::Preferences::Observer
{
public:
    /**
     * Constructor for a boolean value that syncs to the supplied path.
     * Initializes the widget to the current preference stored state and registers callbacks
     * for widget changes and preference changes.
     *
     * @param act the widget to synchronize preference with.
     * @param path the path to the preference the widget is synchronized with.
     * @param callback function to invoke when changes are pushed.
     * @param cbData data to be passed on to the callback function.
     */
    PrefPusher( GtkToggleAction       *act,
                Glib::ustring const &  path,
                void (*callback)(gpointer) = nullptr,
                gpointer cbData = nullptr );

    /**
     * Destructor that unregisters the preference callback.
     */
    ~PrefPusher() override;

    /**
     * Callback method invoked when the preference setting changes.
     */
    void notify(Inkscape::Preferences::Entry const &new_val) override;


private:
    /**
     * Callback hook invoked when the widget changes.
     *
     * @param act the toggle action widget that was changed.
     * @param self the PrefPusher instance the callback was registered to.
     */
   static void toggleCB( GtkToggleAction *act, PrefPusher *self );

    /**
     * Method to handle the widget change.
     *
     * @details Sets the observed path, based on the state of the toggle button
     *          and then runs the callback function
     */
    void handleToggled();

    GtkToggleAction *act;
    void (*callback)(gpointer);
    gpointer cbData;
    bool freeze;
};

}
}
#endif

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :