Référence du fichier src/cairo-dock-dialogs.c


Macros
#define	CAIRO_DOCK_DIALOG_DEFAULT_GAP 20
#define	CAIRO_DOCK_DIALOG_TEXT_MARGIN 3
#define	CAIRO_DOCK_DIALOG_TIP_ROUNDING_MARGIN 10
#define	CAIRO_DOCK_DIALOG_TIP_MARGIN 20
#define	CAIRO_DOCK_DIALOG_TIP_BASE 20
#define	CAIRO_DOCK_DIALOG_MIN_ENTRY_WIDTH 120
#define	CAIRO_DOCK_DIALOG_MAX_ENTRY_WIDTH 300
#define	CAIRO_DOCK_DIALOG_BUTTON_OFFSET 3
#define	CAIRO_DOCK_DIALOG_HGAP 2
#define	CAIRO_DOCK_DIALOG_VGAP 4
Fonctions
void	cairo_dock_load_dialog_buttons (CairoDock pDock, gchar cButtonOkImage, gchar *cButtonCancelImage)
gboolean	cairo_dock_dialog_reference (Icon *pIcon)
void	cairo_dock_dialog_unreference (Icon *pIcon)
CairoDockDialog *	cairo_dock_isolate_dialog (Icon *pIcon)
void	cairo_dock_free_dialog (CairoDockDialog *pDialog)
void	cairo_dock_remove_dialog_if_any (Icon *icon)
GtkWidget *	cairo_dock_build_interactive_widget_for_dialog (const gchar *cInitialAnswer, double fValueForHScale)
CairoDockDialog *	cairo_dock_build_dialog (const gchar cText, Icon pIcon, CairoDock pDock, gchar cImageFilePath, GtkWidget *pInteractiveWidget, GtkButtonsType iButtonsType, CairoDockActionOnAnswerFunc pActionFunc, gpointer data)
void	cairo_dock_dialog_calculate_aimed_point (Icon pIcon, CairoDock pDock, int iX, int iY, gboolean bRight, gboolean bIsPerpendicular, gboolean *bDirectionUp)
void	cairo_dock_dialog_find_optimal_placement (CairoDockDialog pDialog, Icon pIcon, CairoDock *pDock)
void	cairo_dock_place_dialog (CairoDockDialog pDialog, Icon pIcon, CairoDock *pDock)
void	cairo_dock_replace_all_dialogs (void)
CairoDockDialog *	cairo_dock_show_dialog_full (const gchar cText, Icon pIcon, CairoDock pDock, double fTimeLength, gchar cIconPath, GtkButtonsType iButtonsType, GtkWidget *pInteractiveWidget, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
void	cairo_dock_show_temporary_dialog_with_icon (const gchar cText, Icon pIcon, CairoDock pDock, double fTimeLength, gchar cIconPath)
void	cairo_dock_show_temporary_dialog (const gchar cText, Icon pIcon, CairoDock *pDock, double fTimeLength)
void	cairo_dock_show_temporary_dialog_with_default_icon (const gchar cText, Icon pIcon, CairoDock *pDock, double fTimeLength)
CairoDockDialog *	cairo_dock_show_dialog_with_question (const gchar cText, Icon pIcon, CairoDock pDock, gchar cIconPath, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
CairoDockDialog *	cairo_dock_show_dialog_with_entry (const gchar cText, Icon pIcon, CairoDock pDock, gchar cIconPath, const gchar *cTextForEntry, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
CairoDockDialog *	cairo_dock_show_dialog_with_value (const gchar cText, Icon pIcon, CairoDock pDock, gchar cIconPath, double fValue, CairoDockActionOnAnswerFunc pActionFunc, gpointer data, GFreeFunc pFreeDataFunc)
gchar *	cairo_dock_show_dialog_and_wait (const gchar cText, Icon pIcon, CairoDock pDock, double fTimeLength, gchar cIconPath, GtkButtonsType iButtonsType, GtkWidget *pInteractiveWidget)
gchar *	cairo_dock_show_demand_and_wait (const gchar cMessage, Icon pIcon, CairoDock pDock, const gchar cInitialAnswer)
double	cairo_dock_show_value_and_wait (const gchar cMessage, Icon pIcon, CairoDock *pDock, double fInitialValue)
int	cairo_dock_ask_question_and_wait (const gchar cQuestion, Icon pIcon, CairoDock *pDock)
int	cairo_dock_ask_general_question_and_wait (const gchar *cQuestion)
Variables
CairoDock *	g_pMainDock
	pointeur sur le dock principal.
gint	g_iScreenWidth [2]
	dimensions de l'ecran.
gint	g_iScreenHeight [2]
gboolean	g_bSticky
gboolean	g_bKeepAbove
gboolean	g_bAutoHide
	TRUE si l'auto-hide est active.
int	g_iVisibleZoneWidth
	dimensions de la zone ou on place le curseur pour faire apparaitre le dock.
int	g_iVisibleZoneHeight
int	g_iLabelSize
	taille de la police des etiquettes.
gchar *	g_cLabelPolice
	police de caracteres des etiquettes.
int	g_iLabelStyle
	italique ou droit.
int	g_iLabelWeight
	epaisseur des traits.
int	g_iDockLineWidth
	epaisseur du cadre (en pixels).
int	g_iDockRadius
	rayon des coins du cadre.
double	g_fLineColor [4]
	la couleur du cadre.
int	g_iDialogButtonWidth
int	g_iDialogButtonHeight
double	g_fDialogAlpha
int	g_iDialogIconSize

Documentation des macros

#define CAIRO_DOCK_DIALOG_DEFAULT_GAP 20

#define CAIRO_DOCK_DIALOG_TEXT_MARGIN 3

#define CAIRO_DOCK_DIALOG_TIP_ROUNDING_MARGIN 10

#define CAIRO_DOCK_DIALOG_TIP_MARGIN 20

#define CAIRO_DOCK_DIALOG_TIP_BASE 20

#define CAIRO_DOCK_DIALOG_MIN_ENTRY_WIDTH 120

#define CAIRO_DOCK_DIALOG_MAX_ENTRY_WIDTH 300

#define CAIRO_DOCK_DIALOG_BUTTON_OFFSET 3

#define CAIRO_DOCK_DIALOG_HGAP 2

#define CAIRO_DOCK_DIALOG_VGAP 4

Documentation des fonctions

void cairo_dock_load_dialog_buttons ( CairoDock * pDock,

gchar * cButtonOkImage,

gchar * cButtonCancelImage

)

gboolean cairo_dock_dialog_reference ( Icon * pIcon )

void cairo_dock_dialog_unreference ( Icon * pIcon )

CairoDockDialog* cairo_dock_isolate_dialog ( Icon * pIcon )

void cairo_dock_free_dialog ( CairoDockDialog * pDialog )

void cairo_dock_remove_dialog_if_any ( Icon * icon )

GtkWidget* cairo_dock_build_interactive_widget_for_dialog ( const gchar * cInitialAnswer,

double fValueForHScale

)

CairoDockDialog* cairo_dock_build_dialog ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

gchar * cImageFilePath,

GtkWidget * pInteractiveWidget,

GtkButtonsType iButtonsType,

CairoDockActionOnAnswerFunc pActionFunc,

gpointer data

)

void cairo_dock_dialog_calculate_aimed_point ( Icon * pIcon,

CairoDock * pDock,

int * iX,

int * iY,

gboolean * bRight,

gboolean * bIsPerpendicular,

gboolean * bDirectionUp

)

void cairo_dock_dialog_find_optimal_placement ( CairoDockDialog * pDialog,

Icon * pIcon,

CairoDock * pDock

)

void cairo_dock_place_dialog ( CairoDockDialog * pDialog,

Icon * pIcon,

CairoDock * pDock

)

void cairo_dock_replace_all_dialogs ( void )

CairoDockDialog* cairo_dock_show_dialog_full ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

double fTimeLength,

gchar * cIconPath,

GtkButtonsType iButtonsType,

GtkWidget * pInteractiveWidget,

CairoDockActionOnAnswerFunc pActionFunc,

gpointer data,

GFreeFunc pFreeDataFunc

)

Fait apparaitre un dialogue avec un widget et 2 boutons.
Paramètres:

cText le message du dialogue.

pIcon l'icone sur laquelle pointe le dialogue.

pDock le dock contenant l'icone.

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.

pActionFunc la fonction d'action appelee lorsque l'utilisateur valide son choix.

data

pFreeDataFunc

Renvoie:
Si le widget est une entree de texte, retourne le texte si oui, et "" si non. Si le widget est une echelle, retourne la valeur sous forme de chaine si "oui", et "-1" si non, et sinon, retourne "yes" si oui, et "no" si non. Si besoin est, le widget est accessible via le dialogue, lui-meme accessible via l'icone.

void cairo_dock_show_temporary_dialog_with_icon ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant l'icone.

fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).

cIconPath le chemin vers une icone.

void cairo_dock_show_temporary_dialog ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant l'icone.

fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).

void cairo_dock_show_temporary_dialog_with_default_icon ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant l'icone.

fTimeLength la duree de vie du dialogue (ou 0 pour une duree de vie illimitee).

CairoDockDialog* cairo_dock_show_dialog_with_question ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant 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.

CairoDockDialog* cairo_dock_show_dialog_with_entry ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant 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,

CairoDock * pDock,

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.

pDock le dock contenant 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.

gchar* cairo_dock_show_dialog_and_wait ( const gchar * cText,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant l'icone.

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:
La reponse sous la fome d'une chaine de caracters nouvellement allouee. Si le widget est une entree de texte, retourne le texte si oui, et "" si non. Si le widget est une echelle, retourne la valeur sous forme de chaine si "oui", et "-1" si non, et sinon, retourne "yes" si oui, et "no" si non. Si le dialogue est detruit entre-temps, NULL est retourne. Si c'est un autre widget, il faut le referencer avant, de facon a ce qu'il ne soit pas detruit avec le dialogue.

gchar* cairo_dock_show_demand_and_wait ( const gchar * cMessage,

Icon * pIcon,

CairoDock * pDock,

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.

pDock le dock contenant 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,

CairoDock * pDock,

double fInitialValue

)

Fait apparaitre un dialogue avec une echelle horizontale entre 0 et 1, 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.

pDock le dock contenant l'icone.

fInitialValue la valeur initiale de l'echelle, entre 0 et 1.

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,

CairoDock * pDock

)

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.

pDock le dock contenant 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.

int cairo_dock_ask_general_question_and_wait ( const gchar * cQuestion )

Fait apparaitre un dialogue de question bloquant, et pointant sur l'icone pointee du dock principal (ou la 1ere icone 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 .