Main Page | Data Structures | File List | Data Fields | Globals | Related Pages

rox.h File Reference

Top level header for ROX-CLib. More...

#include "rox_debug.h"
#include "choices.h"
#include "options.h"
#include "error.h"
#include "infowin.h"
#include "rox_resources.h"

Functions

void rox_init (const char *program, int *argc, char ***argv)
void rox_init_with_domain (const char *program, const char *domain, int *argc, char ***argv)
const gchar * rox_get_program_name (void)
GdkPixbuf * rox_get_program_icon (void)
const gchar * rox_get_app_dir (void)
int rox_clib_version_number (void)
const char * rox_clib_version_string (void)
int rox_clib_gtk_version_number (void)
const char * rox_clib_gtk_version_string (void)
void rox_add_window (GtkWidget *window)
int rox_get_n_windows (void)
void rox_main_loop (void)
void rox_main_quit (void)


Detailed Description

Top level header for ROX-CLib.

This is the top level header file for ROX-CLib. It provides the usual facilities required by most ROX programs.


Function Documentation

void rox_add_window GtkWidget *  window  ) 
 

Add this window to the ones which are being counted. When it is destroyed this will be noted and the window count decreased.

Parameters:
window Window or other widget to count

int rox_clib_gtk_version_number void   ) 
 

Returns the version number of the GTK+ library encoded as an int

Returns:
10000*major+100*minor+micro

const char* rox_clib_gtk_version_string void   ) 
 

Returns the version number of the GTK+ library as a string

Returns:
"major.minor.micro"

int rox_clib_version_number void   ) 
 

Returns the version number of the library encoded as an int

Returns:
10000*major+100*minor+micro

const char* rox_clib_version_string void   ) 
 

Returns the version number of the library as a string

Returns:
"major.minor.micro"

const gchar* rox_get_app_dir void   ) 
 

Returns the application directory.

Returns:
the application directory, which may be NULL or "" if the AppRun script wasn't called

int rox_get_n_windows void   ) 
 

Return the number of windows ROX-CLib is tracking

Returns:
the number of windows passed to rox_add_window(), minus the number of those destroyed

GdkPixbuf* rox_get_program_icon void   ) 
 

Returns the program icon used for the windows

Returns:
the program icon, or NULL if there isn't one

const gchar* rox_get_program_name void   ) 
 

Returns the program name as passed to rox_init_with_domain()

Returns:
the program name

void rox_init const char *  program,
int *  argc,
char ***  argv
 

Initialize the library. Equivalent to rox_init_with_domain(program, NULL, argc, argv).

Deprecated:
Use rox_init_with_domain() instead.
Parameters:
[in] program name of program
[in,out] argc pointer to argc passed to main()
[in,out] argv pointer to argv passed to main()

void rox_init_with_domain const char *  program,
const char *  domain,
int *  argc,
char ***  argv
 

Initialize the library. This calls:

If .DirIcon exists in $APP_DIR it is set as the default icon for all windows

Parameters:
[in] program name of program
[in] domain domain under the control of the programmer. Used in options and choices
[in,out] argc pointer to argc passed to main()
[in,out] argv pointer to argv passed to main()

void rox_main_loop void   ) 
 

Call gtk_main() repeatedly until either rox_get_n_windows() returns less than one, or rox_main_quit() is called

void rox_main_quit void   ) 
 

Cause rox_main_loop() to exit. If rox_main_loop() has been called recursivly only the innermost is exited.


Generated on Sat Oct 22 17:49:14 2005 for ROX-CLib by doxygen 1.3.8