Page principale   Modules   Liste des namespaces   Hiérarchie des classes   Liste des composants   Liste des fichiers   Membres des namespaces   Composants   Déclarations   Pages associées   Exemples  

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

Boite de dialogue modale. Plus de détails...

#include <gtkppmodaldialogs.hpp>

Graphe d'héritage de la classe lgtkpp::gtkpp_modal_dialog

lgtkpp::gtk_dialog lgtkpp::gtk_window lgtkpp::gtk_bin lgtkpp::gtk_container lgtkpp::gtk_widget lgtkpp::gtk_object lgtkpp::gtkpp_message_box Liste de tous les membres

Membres publics

 gtkpp_modal_dialog ()
 Constructeur par défaut.

virtual ~gtkpp_modal_dialog ()
 Destructeur.

SELF_WIDGET & AddButton (std::string const aLabel, guint aId, bool aExitModal)
 Ajoute un bouton dans le panneau d'action de la boite de dialogue.

virtual void ButtonAction ()
 Fonction appelee après un click de bouton.

SELF_WIDGET & EndModal ()
 Sort de l'état modal.

guint GetReturnValue () const
 Renvoie la valeur de retour actuelle. Par defaut, c'est l'ID du bouton cliqué.

SELF_WIDGET & ModalState (bool aModal)
 Definit l'état modal de la boite de dialogue.

SELF_WIDGET & SetReturnValue (unsigned aValue)
 Definit la valeur de sortie de la boite.

unsigned ShowModal ()
 Affiche et rend modale La boite de dialogue.


Description détaillée

Boite de dialogue modale.

La classe gtkpp_modal_dialog implemente une boite de dialogue modale, c'est à dire une boite qui intercepte les signaux adressée à l'application et ne rend la main que lorsque elle se referme. Ce genre de boite de dialogue est utilisée pour les écrans de configuration et pour toute opération nécessitant une intervention de l'utilsateur pour se poursuivre. Elle constitue la base des boites de messages obtenue par la fonction gtkpp_application::MessageBox. Cette classe n'est pas utilisable directement, mais par l'intermédiaire d'une classe dérivée, en redéfinissant la fonction SetupWidget. La boite de dialogue est constituee de deux partie, la zone superieure qui contient les widgets et la zone inférieure qui contient les boutons. La gestion de la zone supérieure est laissée au créateur de la boite de dialogue. Une reférence sur l'objet gtk_box qui le constitue peut etre obtenue par la fonction héritée de gtk_dialog : GetVBox(). La zone inférieure est géree par la boite elle meme, l'utilisateur n'y accède pas directement. La zone inférieure ne peut contenir que des boutons. Ces boutons sont ajoutée par la fonction AddButton, les bouton disposent de trois propriétés, le texte affiché dans le bouton, l'identificateur du bouton et un flag qui indique si un click sur le bouton sort la boite de dialogue de son état modal. La fonction AddButton se charge de creer le bouton et de connecter ses signaux à la fonction d'interception. Une fois la boite de dialogue créee, elle est affichée au moyen de la fonction ShowDialog. Lorsqu'un bouton est enfoncé, l'état modal est modifié en fonction du flag donné lors de la création du bouton, puis la fonction ButtonAction est appelée. Cette fonction est virtuelle et peut etre derivée. Cette fonction peut donc effectuer des actions spécifiques au bouton et meme annuler les actions par defaut du bouton tel que remodifier l'etat modal. Si la fonction ne le modifie pas, la valeur de retour de ShowModal est l'id du bouton.

Auteur:
Laurent DELEPINE (fenkys@sourceforge.net)
Date:
15 mars 2003


Documentation des contructeurs et destructeurs

lgtkpp::gtkpp_modal_dialog::gtkpp_modal_dialog  
 

Constructeur par défaut.

Crée une boite de dialogue modale. A ce stade la boite n'est pas affichée. Il faut appeler la fonction ShowModal pour rendre la boite active. La bpite s'affiche alors mais vide. Pour ajouter des boutons dedans, il faut utiliser la fonction AddBouton, pour ajouter des widget, il faut redefinir la fonction SetupWidget.

virtual lgtkpp::gtkpp_modal_dialog::~gtkpp_modal_dialog   [inline, virtual]
 

Destructeur.


Documentation des méthodes

gtkpp_modal_dialog::SELF_WIDGET & lgtkpp::gtkpp_modal_dialog::AddButton std::string const    aLabel,
guint    aId,
bool    aExitModal
 

Ajoute un bouton dans le panneau d'action de la boite de dialogue.

Les signaux du bouton sont également connecté de façon a obtenir une action correcte lors du click sur le bouton.

Paramètres:
aLabel Texte du bouton
aId ID du bouton, valeur renvoyee par un click sur le bouton. Cet ID est une valeur positive non nulle.
aExitModal si true, un click sur le bouton sort la boite de son etat modal
Renvoie:
Une référence sur l'objet courant.

void lgtkpp::gtkpp_modal_dialog::ButtonAction   [inline, virtual]
 

Fonction appelee après un click de bouton.

Cette action est appelée après que la valeur de retour de ShowModal ait ete positionnée a l'Id du bouton et que le mode modal soit modifié en fonction du flag aExitModal lors de la creation du bouton. Par défaut cette fonction n'a aucune action, elle doit être surchargée pour être utilisée. Cette fonction est l'endroit parfait pour mettre en place une vérification de la cohérence des données de la boite avant la sortie. La fonction peut modifier les actions par defaut du click sur le bouton.

SELF_WIDGET & lgtkpp::gtkpp_modal_dialog::EndModal   [inline]
 

Sort de l'état modal.

La fonction ShowModal se termine en renvoyant la valeur définie précédement comme valeur de retour.

Renvoie:
Une référence sur l'objet courant.

guint lgtkpp::gtkpp_modal_dialog::GetReturnValue   const [inline]
 

Renvoie la valeur de retour actuelle. Par defaut, c'est l'ID du bouton cliqué.

Cette fonction peut être utilisée par BoutonAction pour connaitre la valeur d'ID du dernier bouton cliqué.

Renvoie:
ID du dernier bouton cliqué, 0 si aucun bouton cliqué ou si l'état modal a été renouvelé par BoutonAction.

SELF_WIDGET & lgtkpp::gtkpp_modal_dialog::ModalState bool    aModal [inline]
 

Definit l'état modal de la boite de dialogue.

Positionne le flag modal sur true ou false. Permet a BoutonAction de changer l'état modal de la boite.

Paramètres:
aModal : état modal désiré.
Renvoie:
Une référence sur l'objet courant.

SELF_WIDGET & lgtkpp::gtkpp_modal_dialog::SetReturnValue unsigned    aValue [inline]
 

Definit la valeur de sortie de la boite.

La valeur definie ici est celle renvoyée en sortie par ShowModal.

Paramètres:
aValue La nouvelle valeur de retour de ShowModal
Renvoie:
Une référence sur l'objet courant.

unsigned lgtkpp::gtkpp_modal_dialog::ShowModal  
 

Affiche et rend modale La boite de dialogue.

Tant que la boite n'est pas fermée, tous les signaux de l'application sont redirigée vers elle et la fonction ne rend pas la main. Pour sortir de la fonction et continuer le déroulement normal de l'application, la fonction EndModal doit être appelée ou un bouton crée avec le flag endModal doit etre clique. La valeur retournée par ShowModal est spécifique de la classe dérivée. Elle permet de fournir une indication à l'utilisateur. Généralement elle permet de savoir comment la boite de dialogue a rendu la main, comme l'id du bouton qui a servi à sortir de l'état modal, dans le cas ou le bouton a ete construit avec le flag endModal a true. Sortir de la fonction ne signifie pas que la boite de dialogue est detruite mais qu'elle a quitté l'état modal. La boite de dialogue est encore visible mais inactive. Elle peut être detruite (elle disparait alors) ou reactivée par appel de la fonction ShowModal (par exemple, après click sur un bouton appliquer)

Renvoie:
Un entier qui représente l'état de la boite de dialogue en sortie. En general cet entier est l'id du bouton cliqué, sauf si ButtonAction l'a modifié.


La documentation associée à cette classe a été générée à partir des fichiers suivants :
Généré le Sun Oct 5 15:03:47 2003 pour lightgtk++ par doxygen1.3-rc3