Référence du fichier /opt/cairo-dock/trunk/cairo-dock/src/cairo-dock-dialogs.h

Aller au code source de ce fichier.

Macros

#define CAIRO_DOCK_IS_DIALOG(pContainer)   (pContainer != NULL && pContainer->iType == CAIRO_DOCK_TYPE_DIALOG)
#define CAIRO_DOCK_DIALOG(pContainer)   ((CairoDockDialog *)pContainer)

Fonctions

void cairo_dock_load_dialog_buttons (CairoDockContainer *pContainer, gchar *cButtonOkImage, gchar *cButtonCancelImage)
gboolean cairo_dock_dialog_reference (CairoDockDialog *pDialog)
gboolean cairo_dock_dialog_unreference (CairoDockDialog *pDialog)
void cairo_dock_isolate_dialog (CairoDockDialog *pDialog)
void cairo_dock_free_dialog (CairoDockDialog *pDialog)
gboolean cairo_dock_remove_dialog_if_any (Icon *icon)
void cairo_dock_remove_orphelans (void)
GtkWidget * cairo_dock_build_common_interactive_widget_for_dialog (const gchar *cInitialAnswer, double fValueForHScale, double fMaxValueForHScale)
CairoDockDialogcairo_dock_build_dialog (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, gchar *cImageFilePath, GtkWidget *pInteractiveWidget, GtkButtonsType iButtonsType, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
void cairo_dock_dialog_calculate_aimed_point (Icon *pIcon, CairoDockContainer *pContainer, int *iX, int *iY, gboolean *bRight, CairoDockTypeHorizontality *bIsHorizontal, gboolean *bDirectionUp)
void cairo_dock_dialog_find_optimal_placement (CairoDockDialog *pDialog)
void cairo_dock_place_dialog (CairoDockDialog *pDialog, CairoDockContainer *pContainer)
void cairo_dock_replace_all_dialogs (void)
CairoDockDialogcairo_dock_show_dialog_full (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, double fTimeLength, gchar *cIconPath, GtkButtonsType iButtonsType, GtkWidget *pInteractiveWidget, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
CairoDockDialogcairo_dock_show_temporary_dialog_with_icon (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, double fTimeLength, gchar *cIconPath,...)
CairoDockDialogcairo_dock_show_temporary_dialog (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, double fTimeLength,...)
CairoDockDialogcairo_dock_show_temporary_dialog_with_default_icon (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, double fTimeLength,...)
CairoDockDialogcairo_dock_show_dialog_with_question (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, gchar *cIconPath, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
CairoDockDialogcairo_dock_show_dialog_with_entry (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, gchar *cIconPath, const gchar *cTextForEntry, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
CairoDockDialogcairo_dock_show_dialog_with_value (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, gchar *cIconPath, double fValue, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
int cairo_dock_show_dialog_and_wait (const gchar *cText, Icon *pIcon, CairoDockContainer *pContainer, double fTimeLength, gchar *cIconPath, GtkButtonsType iButtonsType, GtkWidget *pInteractiveWidget)
gchar * cairo_dock_show_demand_and_wait (const gchar *cMessage, Icon *pIcon, CairoDockContainer *pContainer, const gchar *cInitialAnswer)
double cairo_dock_show_value_and_wait (const gchar *cMessage, Icon *pIcon, CairoDockContainer *pContainer, double fInitialValue, double fMaxValue)
int cairo_dock_ask_question_and_wait (const gchar *cQuestion, Icon *pIcon, CairoDockContainer *pContainer)
gboolean cairo_dock_icon_has_dialog (Icon *pIcon)
Iconcairo_dock_get_dialogless_icon (void)
CairoDockDialogcairo_dock_show_general_message (const gchar *cMessage, double fTimeLength)
int cairo_dock_ask_general_question_and_wait (const gchar *cQuestion)
void cairo_dock_hide_dialog (CairoDockDialog *pDialog)
void cairo_dock_unhide_dialog (CairoDockDialog *pDialog)
GtkWidget * cairo_dock_steal_widget_from_its_container (GtkWidget *pWidget)


Documentation des macros

#define CAIRO_DOCK_IS_DIALOG ( pContainer   )     (pContainer != NULL && pContainer->iType == CAIRO_DOCK_TYPE_DIALOG)

Teste si le container est un dialogue.

Paramètres:
pContainer le container.
Renvoie:
TRUE ssi le container a ete declare comme un dialogue.

#define CAIRO_DOCK_DIALOG ( pContainer   )     ((CairoDockDialog *)pContainer)

Caste un container en dialogue.

Paramètres:
pContainer le container.
Renvoie:
le dialogue.


Documentation des fonctions

void cairo_dock_load_dialog_buttons ( CairoDockContainer pContainer,
gchar *  cButtonOkImage,
gchar *  cButtonCancelImage 
)

gboolean cairo_dock_dialog_reference ( CairoDockDialog pDialog  ) 

Incremente le compteur de reference de 1 de maniere atomique, de maniere a empecher toute destruction du dialogue pendant son utilisation. Utiliser cairo_dock_dialog_unreference apres en avoir termine.

Paramètres:
pDialog le dialogue.
Renvoie:
TRUE ssi la reference sur le dialogue n'etait pas deja nulle et a pu etre incrementee, FALSE sinon, auquel cas il ne faut pas l'utiliser.

gboolean cairo_dock_dialog_unreference ( CairoDockDialog pDialog  ) 

Decremente le compteur de reference de 1 de maniere atomique. Si la reference est tombee a 0, tente de detruire le dialogue si la liste des dialogues n'est pas verouillee, et sinon l'isole (il sera alors detruit plus tard).

Paramètres:
pDialog le dialogue.
Renvoie:
TRUE ssi la reference sur le dialogue est tombee a zero, auquel cas il ne faut plus l'utiliser.

void cairo_dock_isolate_dialog ( CairoDockDialog pDialog  ) 

Isole un dialogue, de maniere a ce qu'il ne soit pas utilise par une nouvelle personne. Les utilisations courantes ne sont pas affectees. N'a aucun effet sur un dialogue deja isole. Ne devrait pas etre utilise tel quel.

Paramètres:
pDialog le dialogue.

void cairo_dock_free_dialog ( CairoDockDialog pDialog  ) 

Detruit un dialogue, libere les ressources allouees, et l'enleve de la liste des dialogues. Ne devrait pas etre utilise tel quel, utiliser cairo_dock_dialog_unreference.

Paramètres:
pDialog le dialogue.

gboolean cairo_dock_remove_dialog_if_any ( Icon icon  ) 

Dereference tous les dialogues pointant sur une icone; si les dialogues sont utilises par quelqu'un d'autre, il seront detruits plus tard, mais seront au moins isoles, et ne pourront donc plus etre utilises par une nouvelle personne.

Paramètres:
icon l'icone dont on veut supprimer les dialogues.
Renvoie:
TRUE ssi au moins un dialogue a ete detruit.

void cairo_dock_remove_orphelans ( void   ) 

Detruit et enleve de la liste tous les dialogues dont la reference est a 0, et qui n'ont pas ete enleves de la liste.

GtkWidget* cairo_dock_build_common_interactive_widget_for_dialog ( const gchar *  cInitialAnswer,
double  fValueForHScale,
double  fMaxValueForHScale 
)

CairoDockDialog* cairo_dock_build_dialog ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
gchar *  cImageFilePath,
GtkWidget *  pInteractiveWidget,
GtkButtonsType  iButtonsType,
CairoDockActionOnAnswerFunc  pActionFunc,
gpointer  data,
GFreeFunc  pFreeDataFunc 
)

void cairo_dock_dialog_calculate_aimed_point ( Icon pIcon,
CairoDockContainer pContainer,
int *  iX,
int *  iY,
gboolean *  bRight,
CairoDockTypeHorizontality bIsHorizontal,
gboolean *  bDirectionUp 
)

void cairo_dock_dialog_find_optimal_placement ( CairoDockDialog pDialog  ) 

void cairo_dock_place_dialog ( CairoDockDialog pDialog,
CairoDockContainer pContainer 
)

void cairo_dock_replace_all_dialogs ( void   ) 

Recalcule la positions de tous les dialogues et les y deplace.

CairoDockDialog* cairo_dock_show_dialog_full ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
double  fTimeLength,
gchar *  cIconPath,
GtkButtonsType  iButtonsType,
GtkWidget *  pInteractiveWidget,
CairoDockActionOnAnswerFunc  pActionFunc,
gpointer  data,
GFreeFunc  pFreeDataFunc 
)

Fait apparaitre un dialogue avec un message, un widget et 2 boutons, tous optionnels.

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container contenant l'icone.
fTimeLength duree de vie du dialogue, ou 0 pour une duree de vie illimitee.
cIconPath le chemin vers une icone a afficher dans la marge.
iButtonsType type des boutons (GTK_BUTTONS_OK_CANCEL, GTK_BUTTONS_YES_NO, ou GTK_BUTTONS_NONE).
pInteractiveWidget un widget d'interaction avec l'utilisateur; il est rattache au dialogue, donc sera detruit avec lui. Faire un 'gtk_widget_reparent()' avant de detruire le dialogue pour eviter cela, ou bien utilisez cairo_dock_show_dialog_and_wait.
pActionFunc la fonction d'action appelee lorsque l'utilisateur valide son choix. NULL revient a avoir des boutons du type GTK_BUTTONS_NONE.
data donnees transmises a la fonction ci-dessus.
pFreeDataFunc fonction de liberation des donnees ci-dessus, appelee lors de la destruction du dialogue, ou NULL si non necessaire.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

CairoDockDialog* cairo_dock_show_temporary_dialog_with_icon ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
double  fTimeLength,
gchar *  cIconPath,
  ... 
)

Fait apparaitre un dialogue a duree de vie limitee avec une icone dans la marge a cote du texte.

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).
cIconPath le chemin vers une icone.
... les arguments a inserer dans la chaine de texte, facon printf.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

CairoDockDialog* cairo_dock_show_temporary_dialog ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
double  fTimeLength,
  ... 
)

Fait apparaitre un dialogue a duree de vie limitee sans icone.

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).
... les arguments a inserer dans la chaine de texte.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

CairoDockDialog* cairo_dock_show_temporary_dialog_with_default_icon ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
double  fTimeLength,
  ... 
)

Fait apparaitre un dialogue a duree de vie limitee et avec l'icone par defaut.

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).
... les arguments a inserer dans la chaine de texte, facon printf.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

CairoDockDialog* cairo_dock_show_dialog_with_question ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
gchar *  cIconPath,
CairoDockActionOnAnswerFunc  pActionFunc,
gpointer  data,
GFreeFunc  pFreeDataFunc 
)

Fait apparaitre un dialogue a duree de vie illimitee avec une question et 2 boutons oui/non. Lorsque l'utilisateur clique sur "oui", la fonction d'action est appelee avec "yes", et avec "no" s'il a clique sur "non".

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
cIconPath le chemin vers une icone a afficher dans la marge.
pActionFunc la fonction d'action, appelee lors du clique utilisateur.
data pointeur qui sera passe en argument de la fonction d'action.
pFreeDataFunc fonction qui liberera le pointeur.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

CairoDockDialog* cairo_dock_show_dialog_with_entry ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
gchar *  cIconPath,
const gchar *  cTextForEntry,
CairoDockActionOnAnswerFunc  pActionFunc,
gpointer  data,
GFreeFunc  pFreeDataFunc 
)

Fait apparaitre un dialogue a duree de vie illimitee avec une entree texte et 2 boutons ok/annuler. Lorsque l'utilisateur clique sur "ok", la fonction d'action est appelee avec le texte de l'entree, et avec "" s'il a clique sur "annuler".

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
cIconPath le chemin vers une icone a afficher dans la marge.
cTextForEntry le texte a afficher initialement dans l'entree.
pActionFunc la fonction d'action, appelee lors du clique utilisateur.
data pointeur qui sera passe en argument de la fonction d'action.
pFreeDataFunc fonction qui liberera le pointeur.
Renvoie:
le dialogue nouvellement cree.

CairoDockDialog* cairo_dock_show_dialog_with_value ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
gchar *  cIconPath,
double  fValue,
CairoDockActionOnAnswerFunc  pActionFunc,
gpointer  data,
GFreeFunc  pFreeDataFunc 
)

Fait apparaitre un dialogue a duree de vie illimitee avec une echelle horizontale et 2 boutons ok/annuler. Lorsque l'utilisateur clique sur "ok", la fonction d'action est appelee avec la valeur de l'echelle sous forme de texte, et avec "-1" s'il a clique sur "annuler".

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
cIconPath le chemin vers une icone a afficher dans la marge.
fValue la valeur initiale de l'echelle.
pActionFunc la fonction d'action, appelee lors du clique utilisateur.
data pointeur qui sera passe en argument de la fonction d'action.
pFreeDataFunc fonction qui liberera le pointeur.
Renvoie:
le dialogue nouvellement cree.

int cairo_dock_show_dialog_and_wait ( const gchar *  cText,
Icon pIcon,
CairoDockContainer pContainer,
double  fTimeLength,
gchar *  cIconPath,
GtkButtonsType  iButtonsType,
GtkWidget *  pInteractiveWidget 
)

Fait apparaitre un dialogue avec un widget et 2 boutons, et met en pause le programme jusqu'a ce que l'utilisateur ait fait son choix.

Paramètres:
cText le message du dialogue.
pIcon l'icone sur laquelle pointe le dialogue.
pContainer le container de l'icone.
fTimeLength duree de vie du dialogue, ou 0 pour une duree de vie illimitee.
cIconPath le chemin vers une icone a afficher dans la marge.
iButtonsType type des boutons (GTK_BUTTONS_OK_CANCEL ou GTK_BUTTONS_YES_NO).
pInteractiveWidget un widget d'interaction avec l'utilisateur.
Renvoie:
GTK_RESPONSE_OK si l'utilisateur a valide, GTK_RESPONSE_CANCEL s'il a annule, GTK_RESPONSE_NONE si le dialogue s'est fait detruire avant que l'utilisateur ait pu repondre. Le widget interactif n'est pas detruit avec le dialogue, ce qui permet de recuperer les modifications effectuees par l'utilisateur. Il vous appartient de le detruire avec gtk_widget_destroy() quand vous en avez fini avec lui.

gchar* cairo_dock_show_demand_and_wait ( const gchar *  cMessage,
Icon pIcon,
CairoDockContainer pContainer,
const gchar *  cInitialAnswer 
)

Fait apparaitre un dialogue avec une entree de texte et 2 boutons ok/annuler, et met en pause le programme jusqu'a ce que l'utilisateur ait fait son choix.

Paramètres:
cMessage le message du dialogue.
pIcon l'icone qui fait la demande.
pContainer le container de l'icone.
cInitialAnswer la valeur initiale de l'entree de texte, ou NULL si aucune n'est fournie.
Renvoie:
le texte entre par l'utilisateur, ou NULL s'il a annule ou si le dialogue s'est fait detruire avant.

double cairo_dock_show_value_and_wait ( const gchar *  cMessage,
Icon pIcon,
CairoDockContainer pContainer,
double  fInitialValue,
double  fMaxValue 
)

Fait apparaitre un dialogue avec une echelle horizontale entre 0 et fMaxValue, et 2 boutons ok/annuler, et met en pause le programme jusqu'a ce que l'utilisateur ait fait son choix.

Paramètres:
cMessage le message du dialogue.
pIcon l'icone qui fait la demande.
pContainer le container de l'icone.
fInitialValue la valeur initiale de l'echelle, entre 0 et 1.
fMaxValue la borne superieure de l'intervalle [0 , max].
Renvoie:
la valeur choisie par l'utilisateur, ou -1 s'il a annule ou si le dialogue s'est fait detruire avant.

int cairo_dock_ask_question_and_wait ( const gchar *  cQuestion,
Icon pIcon,
CairoDockContainer pContainer 
)

Fait apparaitre un dialogue de question pointant sur l'icone pointee (ou la 1ere si aucune n'est pointee) avec une question et 2 boutons oui/non, et met en pause le programme jusqu'a ce que l'utilisateur ait fait son choix.

Paramètres:
cQuestion la question a poser.
pIcon l'icone qui fait la demande.
pContainer le container de l'icone.
Renvoie:
GTK_RESPONSE_YES ou GTK_RESPONSE_NO suivant le choix de l'utilisateur, ou GTK_RESPONSE_NONE si le dialogue s'est fait detruire avant.

gboolean cairo_dock_icon_has_dialog ( Icon pIcon  ) 

Cherche si une icone donnee possede au moins un dialogue.

Paramètres:
pIcon l'icone.
Renvoie:
TRUE ssi l'icone possede au moins un dialogue.

Icon* cairo_dock_get_dialogless_icon ( void   ) 

Cherche une icone propice pour montrer un dialogue d'ordre general, dans le dock principal.

Renvoie:
une icone, ou NULL si le dock est vide.

CairoDockDialog* cairo_dock_show_general_message ( const gchar *  cMessage,
double  fTimeLength 
)

Fait apparaitre un dialogue de message non bloquant, et pointant sur une icone de separateur si possible, ou sinon sur l'icone pointee du dock principal (ou la 1ere icone sans dialogue si aucune n'est pointee). Cela permet a cairo-dock de poser une question d'ordre general.

Paramètres:
cMessage le message.
fTimeLength la duree de vie du dialogue.
Renvoie:
Le dialogue nouvellement cree et visible, avec une reference a 1.

int cairo_dock_ask_general_question_and_wait ( const gchar *  cQuestion  ) 

Fait apparaitre un dialogue de question bloquant, et pointant sur une icone de separateur si possible, ou sinon sur l'icone pointee du dock principal (ou la 1ere icone sans dialogue si aucune n'est pointee). Cela permet a cairo-dock de poser une question d'ordre general.

Paramètres:
cQuestion la question a poser.
Renvoie:
idem que pour cairo_dock_ask_question_and_wait.

void cairo_dock_hide_dialog ( CairoDockDialog pDialog  ) 

Cache un dialogue, sans le detruire.

Paramètres:
pDialog le dialogue.

void cairo_dock_unhide_dialog ( CairoDockDialog pDialog  ) 

Montre et fait prendre le focus a un dialogue.

Paramètres:
pDialog le dialogue.

GtkWidget* cairo_dock_steal_widget_from_its_container ( GtkWidget *  pWidget  ) 

Retire un widget de son container GTK sans le detruire Le widget peut alors etre replace ailleurs ulterieurement.

Paramètres:
pWidget le widget.


Généré le Wed Apr 16 03:27:16 2008 pour Cairo-Dock par  doxygen 1.5.3