File: toolbox.h

package info (click to toggle)
gwyddion 2.47-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 38,180 kB
  • ctags: 37,276
  • sloc: ansic: 317,531; sh: 5,122; xml: 3,583; python: 3,067; makefile: 2,694; cpp: 2,550; pascal: 418; perl: 154; ruby: 130; sed: 17
file content (129 lines) | stat: -rw-r--r-- 5,656 bytes parent folder | download
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
/*
 *  @(#) $Id: toolbox.h 18997 2016-09-24 12:35:42Z yeti-dn $
 *  Copyright (C) 2016 David Necas (Yeti).
 *  E-mail: yeti@gwyddion.net.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

/*< private_header >*/

#ifndef __GWYDDION_TOOLBOX_H__
#define __GWYDDION_TOOLBOX_H__

#include <gtk/gtkwidget.h>
#include <libgwyddion/gwyenum.h>
#include <libgwymodule/gwymoduleloader.h>

G_BEGIN_DECLS

#define GWY_TOOLBOX_WM_ROLE "gwyddion-toolbox"

typedef enum {
    GWY_APP_ACTION_TYPE_GROUP = -2,    /* Only used in the editor. */
    GWY_APP_ACTION_TYPE_NONE = -1,
    GWY_APP_ACTION_TYPE_PLACEHOLDER = 0,
    GWY_APP_ACTION_TYPE_BUILTIN,
    GWY_APP_ACTION_TYPE_PROC,
    GWY_APP_ACTION_TYPE_GRAPH,
    GWY_APP_ACTION_TYPE_TOOL,
    GWY_APP_ACTION_TYPE_VOLUME,
    GWY_APP_ACTION_TYPE_XYZ,
    GWY_APP_ACTION_NTYPES,
} GwyAppActionType;

typedef struct {
    const gchar *name;
    const gchar *stock_id;
    GCallback callback;
    const gchar *nice_name;  /* Menu path? */
    const gchar *tooltip;
    /* TODO: sens flags? */
} GwyToolboxBuiltinSpec;

/* Representation of the toolbox as given in toolbox.xml.
 * This is something we do not modify, except:
 * (a) in the editor
 * (b) by removal of invalid stuff (during construction).
 * The on-disk file is only written by us when the users uses the editor. */
typedef struct {
    GwyAppActionType type;
    GQuark function;
    GQuark icon;
    GwyRunType mode;
} GwyToolboxItemSpec;

typedef struct {
    GArray *item;
    gchar *name;
    GQuark id;
    gboolean translatable;
} GwyToolboxGroupSpec;

typedef struct {
    GArray *group;
    guint width;
    /* Auxiliary data used only inside parsing. */
    GString *path;
    gboolean seen_tool_placeholder;
} GwyToolboxSpec;

void                         gwy_toolbox_rebuild_to_spec  (GwyToolboxSpec *spec);
GwyToolboxSpec*              gwy_parse_toolbox_ui         (gboolean ignore_user);
gboolean                     gwy_save_toolbox_ui          (GwyToolboxSpec *spec,
                                                           GError **error);
GwyToolboxSpec*              gwy_toolbox_spec_duplicate   (GwyToolboxSpec *spec);
void                         gwy_toolbox_spec_free        (GwyToolboxSpec *spec);
void                         gwy_toolbox_spec_remove_item (GwyToolboxSpec *spec,
                                                           guint i,
                                                           guint j);
void                         gwy_toolbox_spec_remove_group(GwyToolboxSpec *spec,
                                                           guint i);
void                         gwy_toolbox_spec_move_item   (GwyToolboxSpec *spec,
                                                           guint i,
                                                           guint j,
                                                           gboolean up);
void                         gwy_toolbox_spec_move_group  (GwyToolboxSpec *spec,
                                                           guint i,
                                                           gboolean up);
void                         gwy_toolbox_spec_add_item    (GwyToolboxSpec *spec,
                                                           GwyToolboxItemSpec *ispec,
                                                           guint i,
                                                           guint j);
void                         gwy_toolbox_spec_add_group   (GwyToolboxSpec *spec,
                                                           GwyToolboxGroupSpec *gspec,
                                                           guint i);
void                         gwy_toolbox_editor           (void);
const GwyToolboxBuiltinSpec* gwy_toolbox_get_builtins     (guint *nspec);
const GwyToolboxBuiltinSpec* gwy_toolbox_find_builtin_spec(const gchar *name);
const gchar*                 gwy_toolbox_action_type_name (GwyAppActionType type);
GwyAppActionType             gwy_toolbox_find_action_type (const gchar *name);
const gchar*                 gwy_toolbox_mode_name        (GwyRunType mode);
GwyRunType                   gwy_toolbox_find_mode        (const gchar *name);
const gchar*                 gwy_toolbox_action_nice_name (GwyAppActionType type,
                                                           const gchar *name);
const gchar*                 gwy_toolbox_action_stock_id  (GwyAppActionType type,
                                                           const gchar *name);
const gchar*                 gwy_toolbox_action_detail    (GwyAppActionType type,
                                                           const gchar *name);
GwyRunType                   gwy_toolbox_action_run_modes (GwyAppActionType type,
                                                           const gchar *name);

G_END_DECLS

#endif /* __GWYDDION_TOOLBOX_H__ */

/* vim: set cin et ts=4 sw=4 cino=>1s,e0,n0,f0,{0,}0,^0,\:1s,=0,g1s,h0,t0,+1s,c3,(0,u0 : */