---

Référence de la classe lgtkpp::gtkpp_application
[extensions]

Objet application du programme. Plus de détails...

#include <gtkppapplications.hpp>

Liste de tous les membres

Membres publics
	gtkpp_application (int *argc, char ***argv)
	Constructeur de la classe gtkpp_application.
virtual	~gtkpp_application ()
	Efface la fenetre principale et libere l'application.
void	ExitMainLoop (int aValue)
	Sort de la boucle principale de l'application.
int	MainLoop ()
	Boucle principale de l'application.
gtkpp_application &	ProcessMessage ()
	Assure le traitement des messages en attente.
timeout_id	TimeoutAdd (timeout_fctn, milli_sec, bool=true)
	Positionne un handler sur horloge.
gtkpp_application &	TimeoutRemove (timeout_id)
	Supprime un handle sur horloge.
gtk_window const *	GetMainWindow () const
	Renvoie un pointeur constant sur la fenetre principale.
gtkpp_application &	SetMainWindow (gtk_window *w)
	Definit la fenetre principale de l'application.
unsigned	MessageBox (std::string aMessage, std::string aCaption, int aStyle)
	Affiche une boite de message.
Membres publics statiques
gtkpp_application *	GetApplication ()
	Renvoie un pointeur sur l'objet application courant.
Types Protégés
typedef void(gtkpp_application::*	callback )()
	type fonction callback generique.
typedef callback	timeout_fctn
	type fonction callback pour evenement d'horloge
typedef callback	idle_fctn
	type fonction callback pour evenement idle
typedef std_id	timeout_id
	type identificateur de handler d'horloge
typedef std_id	idle_id
	type identificateur de handler idle
Membres protégés
gtk_window *	GetMainWindow ()
	Renvoie un pointeur sur la fenetre principale.

---

Description détaillée

Objet application du programme.

La classe gtkpp_application gère le fonctionnement général du programme. Elle assure l'initialisation et la liberation correcte des librairies, elle crée et affiche la fenêtre principale et elle contient la boucle principale du programme. Elle centralise les fonctions utilisée par l'ensemble des modules du programme. Cette classe peut être utilisée telle quelle, mais il est préférable de la dériver.

Auteur:

Laurent DELEPINE (fenkys@sourceforge.net)

Date:

15 mars 2003

---

Documentation des types imbriqués

typedef void(gtkpp_application::* lgtkpp::gtkpp_application::callback)() [protected]

type fonction callback generique.

typedef callback lgtkpp::gtkpp_application::idle_fctn [protected]

type fonction callback pour evenement idle

typedef std_id lgtkpp::gtkpp_application::idle_id [protected]

type identificateur de handler idle

typedef callback lgtkpp::gtkpp_application::timeout_fctn [protected]

type fonction callback pour evenement d'horloge

typedef std_id lgtkpp::gtkpp_application::timeout_id [protected]

type identificateur de handler d'horloge

---

Documentation des contructeurs et destructeurs

lgtkpp::gtkpp_application::gtkpp_application (  int *    argc, char ***    argv )

Constructeur de la classe gtkpp_application. Elle vérifie que l'objet application est unique. Si c'est le cas, elle initialise la librairie gtk+. Toute tentative de création d'un second objet d type application générera l'emission d'une exception logic_error. Paramètres: argc  pointeur sur l'argument argc de la fonction main argv  pointeur sur l'argument argv de la fonction main

lgtkpp::gtkpp_application::~gtkpp_application (    )  [virtual]

Efface la fenetre principale et libere l'application.

---

Documentation des méthodes

void lgtkpp::gtkpp_application::ExitMainLoop (  int    aValue )

Sort de la boucle principale de l'application. Suite à l'appel de cette fonction, La fonction MainLoop rend la main avec pour valeur de retour la valeur transmise en parametre. Paramètres: aValue  valeur de sortie du programme.

gtkpp_application * lgtkpp::gtkpp_application::GetApplication (    )  [static]

Renvoie un pointeur sur l'objet application courant. L'usage de cette fonction est deconseillé. Il est préférable d'utiliser la fonction GetApplication() générique qui renvoie une référence sur un objet application du type correct. Renvoie: Pointeur sur l'objet application.

gtk_window const * lgtkpp::gtkpp_application::GetMainWindow (    )  const [inline]

Renvoie un pointeur constant sur la fenetre principale. La fenetre est celle definie par SetMainWindow Renvoie: Le pointeur sur la fenetre principale de l'application.

gtk_window * lgtkpp::gtkpp_application::GetMainWindow (    )  [inline, protected]

Renvoie un pointeur sur la fenetre principale. La fenetre est celle definie par SetMainWindow Renvoie: Le pointeur sur la fenetre principale de l'application.

int lgtkpp::gtkpp_application::MainLoop (    )

Boucle principale de l'application. Elle affiche la fenetre principale si elle existe puis entre dans la boucle principale du GTK+. Renvoie: valeur de sortie du programme

unsigned lgtkpp::gtkpp_application::MessageBox (  std::string    aMessage, std::string    aCaption, int    aStyle )

Affiche une boite de message. Affiche une boite de dialogue modale contenant un message d'information et attendant une réaction de l'utilisateur sous la forme d'un click sur un bouton. Le message, le titre de la boite de message, la disposition des boutons et une icone d'illustration est au choix de l'utilisateur. Paramètres: aMessage  message a afficher dans la boite aCaption  titre de la boite de message aStyle  style la boite de message. Un ou entre plusieurs constantes MB_*. Voir la classe lgtkpp::gtkpp_message_box pour les détails. Renvoie: ID du bouton enfoncé.

gtkpp_application & lgtkpp::gtkpp_application::ProcessMessage (    )

Assure le traitement des messages en attente. Cette fonction est a appeler pour assurer le traitement et eviter de bloquer le programmes lorsque la tache en cours stoppe la boucle principale et arrete le traitement automatique des messages : dans les boites de dialogues modales (autres que celles derivant de gtkpp_modal_dialog) et dans les taches de longues durées. Renvoie: Reference sur l'objet application.

gtkpp_application & lgtkpp::gtkpp_application::SetMainWindow (  gtk_window *    aWindow )

Definit la fenetre principale de l'application. Le pointeur transmis en parametre est adopté par l'application. Il sera detruit en meme temps que l'application. Definir une seconde fois la fenetre provoque l'emission d'une exception logic_error. Paramètres: aWindow  pointeur sur la fenetre de l'application Renvoie: reference sur l'objet courant

gtkpp_application::timeout_id lgtkpp::gtkpp_application::TimeoutAdd (  timeout_fctn    Fonction, milli_sec    Intervalle, bool    Reset = true )

Positionne un handler sur horloge. Le handler transmis en parametre sera appelé quand l'intervalle de temps definit sera ecoulé. Paramètres: Fonction  pointeur sur la fonction a appeler Intervalle  Intervalle entre deux appels en ms Reset  Si true l'appel est reactivé, si false elle sera appelée une seule fois. Renvoie: L'identificateur de la fonction stockée.

gtkpp_application & lgtkpp::gtkpp_application::TimeoutRemove (  timeout_id    aId )

Supprime un handle sur horloge. Paramètres: aId  ID du timer a enlever Renvoie: reference sur l'objet courant

---

La documentation associée à cette classe a été générée à partir des fichiers suivants :

• gtkppapplications.hpp
• gtkppapplications.cpp

---