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
|
/* File: gui_sketch_background.h; Copyright and License: see below */
#ifndef GUI_SKETCH_BACKGROUND_H
#define GUI_SKETCH_BACKGROUND_H
/* public file for the doxygen documentation: */
/*!
* \file
* \brief Draws background graphics below diagrams
*/
#include "gui_resources.h"
#include "shape/shape_int_rectangle.h"
#include <gtk/gtk.h>
#include <stdbool.h>
/*!
* \brief attributes of the sketch background
*/
struct gui_sketch_background_struct {
shape_int_rectangle_t bounds; /*!< bounding box of the background */
gui_resources_t *resources; /*!< pointer to external resources */
};
typedef struct gui_sketch_background_struct gui_sketch_background_t;
/*!
* \brief initializes the sketch background
*
* \param this_ pointer to own object attributes
* \param resources pointer to a resource provider
*/
void gui_sketch_background_init( gui_sketch_background_t *this_, gui_resources_t *resources );
/*!
* \brief destroys the sketch background
*
* \param this_ pointer to own object attributes
*/
void gui_sketch_background_destroy( gui_sketch_background_t *this_ );
/*!
* \brief gets the bounds rectangle
*
* \param this_ pointer to own object attributes
* \return returns the bounding box of this sketch card
*/
static inline shape_int_rectangle_t gui_sketch_background_get_bounds( gui_sketch_background_t *this_ );
/*!
* \brief sets the bounds rectangle
*
* \param this_ pointer to own object attributes
* \param bounds bounding box of this sketch card
*/
static inline void gui_sketch_background_set_bounds( gui_sketch_background_t *this_, shape_int_rectangle_t bounds );
/*!
* \brief draws background graphics to the cairo context, including the introduction
*
* \param this_ pointer to own object attributes
* \param cr cairo drawing context
*/
void gui_sketch_background_draw_introduction( gui_sketch_background_t *this_,
cairo_t *cr
);
/*!
* \brief draws background graphics to the cairo context for navigation mode
*
* \param this_ pointer to own object attributes
* \param tree_depth depth of the current diagram in the tree. 0 represents the root node or no valid diagram.
* \param num_children number of children at the current diagram.
* \param cr cairo drawing context
*/
void gui_sketch_background_draw_navigation( gui_sketch_background_t *this_,
unsigned int tree_depth,
unsigned int num_children,
cairo_t *cr
);
/*!
* \brief draws background graphics to the cairo context for search mode
*
* \param this_ pointer to own object attributes
* \param cr cairo drawing context
*/
void gui_sketch_background_draw_search( gui_sketch_background_t *this_, cairo_t *cr );
/*!
* \brief draws background graphics to the cairo context for edit mode
*
* \param this_ pointer to own object attributes
* \param cr cairo drawing context
*/
void gui_sketch_background_draw_edit( gui_sketch_background_t *this_, cairo_t *cr );
/*!
* \brief draws background graphics to the cairo context for create mode
*
* \param this_ pointer to own object attributes
* \param cr cairo drawing context
*/
void gui_sketch_background_draw_create( gui_sketch_background_t *this_, cairo_t *cr );
/*!
* \brief draws a quick-introduction to the cairo context
*
* \param this_ pointer to own object attributes
* \param cr cairo drawing context
*/
void gui_sketch_background_private_draw_quick_introduction( gui_sketch_background_t *this_, cairo_t *cr );
/*!
* \brief draws an icon and two lines of text
*
* \param this_ pointer to own object attributes
* \param icon_1 a pointer to an icon
* \param text_1 a pointer to a text message, line 1
* \param text_2 a pointer to a text message, line 2
* \param x coordinate of the output location
* \param y coordinate of the output location
* \param cr cairo drawing context
*/
void gui_sketch_background_private_draw_icon_and_message( gui_sketch_background_t *this_,
GdkPixbuf *icon_1,
const char *text_1,
const char *text_2,
int x,
int y,
cairo_t *cr
);
#include "gui_sketch_background.inl"
#endif /* GUI_SKETCH_BACKGROUND_H */
/*
Copyright 2017-2023 Andreas Warnke
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
|
