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
|
/*
gtkui_api.h -- API of the DeaDBeeF GTK UI plugin
http://deadbeef.sourceforge.net
Copyright (C) 2009-2012 Alexey Yakovenko
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Note: DeaDBeeF player itself uses different license
*/
#ifndef __GTKUI_API_H
#define __GTKUI_API_H
#define GTKUI_API_VERSION 1 // for compile-time checking
typedef struct ddb_gtkui_widget_s {
const char *type;
char *name;
struct ddb_gtkui_widget_s *parent;
GtkWidget *widget;
uint32_t flags;
// all the functions here are overloads, so they are not mandatory
// they can be implemented to add custom code to normal widget code
// they can be NULL if you don't need them, or you can set them to
// standard functions (more below)
// this function will be called after the widget is visible and needs to
// [re]initialize itself
// e.g. splitter widget sets the grip position in the init
void (*init) (struct ddb_gtkui_widget_s *container);
// save your custom parameters in the string using strncat
// for example, if you need to write width and height:
// strncat (s, "100 200", sz);
void (*save) (struct ddb_gtkui_widget_s *w, char *s, int sz);
// this is to read custom widget parameters, e.g. width and height
// you will be passed a string looking like "100 200 {"
// you will need to read params, and return the new pointer, normally it
// should be pointing to the "{"
const char *(*load) (struct ddb_gtkui_widget_s *w, const char *s);
// custom destructor code
void (*destroy) (struct ddb_gtkui_widget_s *w);
// custom append code
// if left NULL, appending will not be supported
// you should use standard w_container_add if your widget is derived from
// GTK_CONTAINER
void (*append) (struct ddb_gtkui_widget_s *container, struct ddb_gtkui_widget_s *child);
// custom remove code
// you should use w_container_remove if your widget is derived from
// GTK_CONTAINER
void (*remove) (struct ddb_gtkui_widget_s *container, struct ddb_gtkui_widget_s *child);
// custom replace code
// default replace will call remove;destroy;append
// but you can override if you need smarter behaviour
// look at the splitter and tabs implementation for more details
void (*replace) (struct ddb_gtkui_widget_s *container, struct ddb_gtkui_widget_s *child, struct ddb_gtkui_widget_s *newchild);
// implement this if you want to handle deadbeef broadcast messages/events
int (*message) (struct ddb_gtkui_widget_s *w, uint32_t id, uintptr_t ctx, uint32_t p1, uint32_t p2);
// this will be called to setup the menu widget in design mode
void (*initmenu) (struct ddb_gtkui_widget_s *w, GtkWidget *menu);
// this will be called to setup the child menu widget in design mode
// for example, to add "expand"/"fill" options for hbox/vbox children
void (*initchildmenu) (struct ddb_gtkui_widget_s *w, GtkWidget *menu);
// you shouldn't touch this list normally, the system takes care of it
struct ddb_gtkui_widget_s *children;
struct ddb_gtkui_widget_s *next; // points to next widget in the same container
} ddb_gtkui_widget_t;
typedef struct {
DB_gui_t gui;
int api_version;
// returns main window ptr
GtkWidget * (*get_mainwin) (void);
// register the new widget
void (*w_reg_widget) (const char *type, const char *title, ddb_gtkui_widget_t *(*create_func) (void));
// unregister the widget
void (*w_unreg_widget) (const char *type);
// returns 1 if a widget of the specified is registered
int (*w_is_registered) (const char *type);
// returns toplevel widget
ddb_gtkui_widget_t * (*w_get_rootwidget) (void);
// create a widget oof specified type
ddb_gtkui_widget_t * (*w_create) (const char *type);
// set widget name
void (*w_set_name) (ddb_gtkui_widget_t *w, const char *name);
// destroy the widget
void (*w_destroy) (ddb_gtkui_widget_t *w);
// append the widget to container
void (*w_append) (ddb_gtkui_widget_t *cont, ddb_gtkui_widget_t *child);
// replace existing child widget with another widget
void (*w_replace) (ddb_gtkui_widget_t *w, ddb_gtkui_widget_t *from, ddb_gtkui_widget_t *to);
// remove the widget from its container
void (*w_remove) (ddb_gtkui_widget_t *cont, ddb_gtkui_widget_t *child);
} ddb_gtkui_t;
#endif
|
