/
gnc-gnome-utils.h
137 lines (119 loc) · 4.96 KB
/
gnc-gnome-utils.h
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
/********************************************************************\
* gnc-gnome-utils.h -- utility functions for gnome for GnuCash *
* Copyright (C) 2001 Linux Developers Group *
* Copyright (C) 2003 David Hampton <hampton@employees.org> *
* *
* 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, contact: *
* *
* Free Software Foundation Voice: +1-617-542-5942 *
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
* Boston, MA 02110-1301, USA gnu@gnu.org *
* *
\********************************************************************/
/** @addtogroup GUI
@{ */
/** @addtogroup GuiGnome Gnome-specific GUI handling.
@{ */
/** @file gnc-gnome-utils.h
@brief Gnome specific utility functions.
@author Copyright (C) 2001 Linux Developers Group
@author Copyright (C) 2003 David Hampton <hampton@employees.org>
*/
#ifndef GNC_GNOME_UTILS_H
#define GNC_GNOME_UTILS_H
#include <libgnome/libgnome.h>
#include <gnc-main-window.h>
/** Initialize the Gnome libraries. */
void gnc_gnome_init (int argc, char **argv, const char * version);
/** Given a pixmap/pixbuf file name, find the file in the pixmap
* directory associated with this application. This routine will
* display an error message if it can't find the file.
*
* @param name The name of the file to be found.
*
* @return the full path name of the file, or NULL of the file can't
* be found.
*
* @note It is the caller's responsibility to free the returned string.
*/
char *gnc_gnome_locate_pixmap (const char *name);
/** Given a file name, find the file in the directories associated
* with this application. This routine will display an error message
* if it can't find the file.
*
* @param name The name of the file to be found.
*
* @return the full path name of the file, or NULL of the file can't
* be found.
*
* @note It is the caller's responsibility to free the returned string.
*/
char *gnc_gnome_locate_data_file (const char *name);
/** Given a file name, find the file in the directories associated
* with this application. This routine will display an error message
* if it can't find the file.
*
* @param name The name of the file to be found.
*
* @return the full path name of the file, or NULL of the file can't
* be found.
*
* @note It is the caller's responsibility to free the returned string.
*/
char *gnc_gnome_locate_ui_file (const char *name);
/** Launch the default gnome help browser and open to a given link
* within a given file. This routine will display an error message
* if it can't find the help file or can't open the help browser.
*
* @param file_name The name of the help file.
*
* @param anchor The anchor the help browser should scroll to..
*
* @return the full path name of the file, or NULL of the file can't
* be found.
*/
void gnc_gnome_help (const char *file_name,
const char *anchor);
/** Given a file name, find and load the requested pixmap. This
* routine will display an error message if it can't find the file or
* load the pixmap.
*
* @param name The name of the pixmap file to load.
*
* @return A pointer to the pixmap, or NULL of the file couldn't
* be found or loaded..
*/
GtkWidget * gnc_gnome_get_pixmap (const char *name);
/** Given a file name, find and load the requested pixbuf. This
* routine will display an error message if it can't find the file or
* load the pixbuf.
*
* @param name The name of the pixbuf file to load.
*
* @return A pointer to the pixbuf, or NULL of the file couldn't
* be found or loaded..
*/
GdkPixbuf * gnc_gnome_get_gdkpixbuf (const char *name);
/** Shutdown gnucash. This function will initiate an orderly
* shutdown, and when that has finished it will exit the program.
*
* @param exit_status The exit status for the program.
*/
void gnc_shutdown (int exit_status);
GncMainWindow *gnc_gui_init (void);
int gnc_ui_start_event_loop (void);
gboolean gnucash_ui_is_running (void);
#endif
/** @} */
/** @} */