~ubuntu-branches/ubuntu/trusty/grafx2/trusty

« back to all changes in this revision

Viewing changes to help.h

  • Committer: Bazaar Package Importer
  • Author(s): Gürkan Sengün
  • Date: 2009-09-21 14:24:19 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921142419-lhpqq102buior0ol
Tags: 2.1-1
New upstream version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*  Grafx2 - The Ultimate 256-color bitmap paint program
2
 
 
3
 
    Copyright 2007 Adrien Destugues
4
 
    Copyright 1996-2001 Sunset Design (Guillaume Dorme & Karl Maritaud)
5
 
 
6
 
    Grafx2 is free software; you can redistribute it and/or
7
 
    modify it under the terms of the GNU General Public License
8
 
    as published by the Free Software Foundation; version 2
9
 
    of the License.
10
 
 
11
 
    Grafx2 is distributed in the hope that it will be useful,
12
 
    but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 
    GNU General Public License for more details.
15
 
 
16
 
    You should have received a copy of the GNU General Public License
17
 
    along with Grafx2; if not, see <http://www.gnu.org/licenses/>
18
 
*/
19
 
 
20
 
//////////////////////////////////////////////////////////////////////////////
21
 
///@file help.h
22
 
/// Functions related to the help browser. The help data is in helpfile.h
23
 
//////////////////////////////////////////////////////////////////////////////
24
 
 
25
 
#ifndef __HELP_H_
26
 
#define __HELP_H_
27
 
 
28
 
/*!
29
 
    Called to open the help window with the keyboard shortcut.
30
 
    If the mouse is over a button, its contextual help will be displayed.
31
 
    Else, the default helpscreen will be shown.
32
 
*/
33
 
void Button_Help(void);
34
 
 
35
 
/*!
36
 
    Displays and runs the "Statistics" window
37
 
*/
38
 
void Button_Stats(void);
39
 
 
40
 
/*!
41
 
    Displays and runs the "Help / About..." window
42
 
    @param section Number of the help section page to display (equals the button number the mouse was hovering for the contextual help), -1 for the main help page.
43
 
    @param sub_section Help sub-section title (the page will be scrolled so this title is at the top).
44
 
*/
45
 
void Window_help(int section, const char * sub_section);
46
 
 
47
 
#endif
48
 
 
 
1
/*  Grafx2 - The Ultimate 256-color bitmap paint program
 
2
 
 
3
    Copyright 2007 Adrien Destugues
 
4
    Copyright 1996-2001 Sunset Design (Guillaume Dorme & Karl Maritaud)
 
5
 
 
6
    Grafx2 is free software; you can redistribute it and/or
 
7
    modify it under the terms of the GNU General Public License
 
8
    as published by the Free Software Foundation; version 2
 
9
    of the License.
 
10
 
 
11
    Grafx2 is distributed in the hope that it will be useful,
 
12
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
    GNU General Public License for more details.
 
15
 
 
16
    You should have received a copy of the GNU General Public License
 
17
    along with Grafx2; if not, see <http://www.gnu.org/licenses/>
 
18
*/
 
19
 
 
20
//////////////////////////////////////////////////////////////////////////////
 
21
///@file help.h
 
22
/// Functions related to the help browser. The help data is in helpfile.h
 
23
//////////////////////////////////////////////////////////////////////////////
 
24
 
 
25
#ifndef __HELP_H_
 
26
#define __HELP_H_
 
27
 
 
28
/*!
 
29
    Called to open the help window with the keyboard shortcut.
 
30
    If the mouse is over a button, its contextual help will be displayed.
 
31
    Else, the default helpscreen will be shown.
 
32
*/
 
33
void Button_Help(void);
 
34
 
 
35
/*!
 
36
    Displays and runs the "Statistics" window
 
37
*/
 
38
void Button_Stats(void);
 
39
 
 
40
/*!
 
41
    Displays and runs the "Help / About..." window
 
42
    @param section Number of the help section page to display (equals the button number the mouse was hovering for the contextual help), -1 for the main help page.
 
43
    @param sub_section Help sub-section title (the page will be scrolled so this title is at the top).
 
44
*/
 
45
void Window_help(int section, const char * sub_section);
 
46
 
 
47
#endif
 
48