summaryrefslogtreecommitdiffstats
path: root/src/ui/contextmenu.h
blob: 0e1bcffa060df40b422abbdf9065c80bd5676acc (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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SEEN_CONTEXTMENU_H
#define SEEN_CONTEXTMENU_H

/*
 * Context menu
 *
 * Authors:
 *   Lauris Kaplinski <lauris@kaplinski.com>
 *   Frank Felfe <innerspace@iname.com>
 *   Abhishek Sharma
 *   Kris De Gussem <Kris.DeGussem@gmail.com>
 *
 * Copyright (C) 2012 Kris De Gussem
 * Copyright (C) 1999-2002 authors
 * Copyright (C) 2001-2002 Ximian, Inc.
 *
 * Released under GNU GPL v2+, read the file 'COPYING' for more information.
 */

#include <gtkmm/menu.h>

class SPDesktop;
class SPItem;
class SPObject;

namespace Gtk {
class SeparatorMenuItem;
}

namespace Inkscape {
class Verb;
}

/**
 * Implements the Inkscape context menu.
 * 
 * For the context menu implementation, the ContextMenu class stores the object
 * that was selected in a private data member. This should be fairly safe to do
 * and a pointer to the SPItem as well as SPObject class are kept.
 * All callbacks of the context menu entries are implemented as private
 * functions.
 * 
 * @todo add callbacks to destroy the context menu when it is closed (=key or mouse button pressed out of the scope of the context menu)
 */
class ContextMenu : public Gtk::Menu
{
    public:
        /**
         * The ContextMenu constructor contains all code to create and show the
         * menu entries (aka child widgets).
         * 
         * @param desktop pointer to the desktop the user is currently working on.
         * @param item SPItem pointer to the object selected at the time the ContextMenu is created.
         */
        ContextMenu(SPDesktop *desktop, SPItem *item);
        ~ContextMenu() override;

        /**
         * install CSS to shift menu icons into the space reserved for toggles (i.e. check and radio items)
         *
         * TODO: This should be private but we already re-use this code in ui/interface.cpp which is not c++ified yet.
         *       In future ContextMenu and the (to be created) class for the menu bar should then be derived from one common base class.
         */
        void ShiftIcons();
    private:
        SPItem *_item; // pointer to the object selected at the time the ContextMenu is created
        SPObject *_object; // pointer to the object selected at the time the ContextMenu is created
        SPDesktop *_desktop; //pointer to the desktop the user was currently working on at the time the ContextMenu is created
        
        int positionOfLastDialog;
        
        Gtk::MenuItem MIGroup; //menu entry to enter a group
        Gtk::MenuItem MIParent; //menu entry to leave a group
        
        /**
         * auxiliary function that adds a separator line in the context menu
         */
        Gtk::SeparatorMenuItem* AddSeparator();
        
        /**
         * Appends a custom menu UI from a verb.
         * 
         * c++ified version of sp_ui_menu_append_item.
         * @see sp_ui_menu_append_item_from_verb and synchronize/drop that function when c++ifying other code in interface.cpp
         * 
         * @param show_icon True if an icon should be displayed before the menu item's label
         * 
         */
        void AppendItemFromVerb(Inkscape::Verb *verb, bool show_icon = false);
        
        /**
         * main function which is responsible for creating the context sensitive menu items,
         * calls subfunctions below to create the menu entry widgets.
         */
        void MakeObjectMenu (); 
        /**
         * creates menu entries for an SP_TYPE_ITEM object
         */
        void MakeItemMenu   ();
        /**
         * creates menu entries for a grouped object
         */
        void MakeGroupMenu  ();
        /**
         * creates menu entries for an anchor object
         */
        void MakeAnchorMenu ();
        /**
         * creates menu entries for a bitmap image object
         */
        void MakeImageMenu  ();
        /**
         * creates menu entries for a shape object
         */
        void MakeShapeMenu  ();
        /**
         * creates menu entries for a text object
         */
        void MakeTextMenu   ();
        
        void EnterGroup(Gtk::MenuItem* mi);
        void LeaveGroup();
        void LockSelected();
        void HideSelected();
        void UnLockBelow(std::vector<SPItem *> items);
        void UnHideBelow(std::vector<SPItem *> items);
        //////////////////////////////////////////
        //callbacks for the context menu entries of an SP_TYPE_ITEM object
        void ItemProperties();
        void ItemSelectThis();
        void ItemMoveTo();
        void SelectSameFillStroke();
        void SelectSameFillColor();
        void SelectSameStrokeColor();
        void SelectSameStrokeStyle();
        void SelectSameObjectType();
        void ItemCreateLink();
        void CreateGroupClip();
        void SetMask();
        void ReleaseMask();
        void SetClip();
        void ReleaseClip();
        //////////////////////////////////////////
        
        
        /**
         * callback, is executed on clicking the anchor "Group" and "Ungroup" menu entry
         */
        void ActivateUngroupPopSelection();
        void ActivateUngroup();
        void ActivateGroup();
        
        void AnchorLinkProperties();
        /**
         * placeholder for callback to be executed on clicking the anchor "Follow link" context menu entry
         * @todo add code to follow link externally
         */
        void AnchorLinkFollow();
        
        /**
         * callback, is executed on clicking the anchor "Link remove" menu entry
         */
        void AnchorLinkRemove();
        
        
        /**
         * callback, opens the image properties dialog and is executed on clicking the context menu entry with similar name
         */
        void ImageProperties();
        
        /**
         * callback, is executed on clicking the image "Edit Externally" menu entry
         */
        void ImageEdit();
        
        /**
         * auxiliary function that loads the external image editor name from the settings.
         */
        Glib::ustring getImageEditorName(bool is_svg = false);
        
        /**
         * callback, is executed on clicking the "Embed Image" menu entry
         */
        void ImageEmbed();
        
        /**
         * callback, is executed on clicking the "Trace Bitmap" menu entry
         */
        void ImageTraceBitmap();

        /**
         * callback, is executed on clicking the "Extract Image" menu entry
         */
        void ImageExtract();
        
        
        /**
         * callback, is executed on clicking the "Fill and Stroke" menu entry
         */
        void FillSettings();
        
        
        /**
         * callback, is executed on clicking the "Text and Font" menu entry
         */
        void TextSettings();
        
        /**
         * callback, is executed on clicking the "Check spelling" menu entry
         */
        void SpellcheckSettings();
};
#endif // SEEN_CONTEXT_MENU_H

/*
  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 :