← Back to branch summary

~cairo-dock-team/ubuntu/precise/cairo-dock/988102

« back to all changes in this revision

Viewing changes to doc/latex/cairo-dock-dock-manager_8h.tex

  • Committer: Bazaar Package Importer
  • Author(s): Julien Lavergne
  • Date: 2008-09-14 16:26:12 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080914162612-t6aa8pr2o0qry48o
Tags: 1.6.2.3-0ubuntu1
* New upstream release.
* debian/control
 - Update to 3.8.0 (no change needed).
 - Add libxtst-dev as Build-Depends.
* debian/cairo-dock-data.install
 - Add usr/share/cairo-dock/emblems directory.
* debian/watch
 - Update location.
* debian/rules
 - Add a get-orig-source rule.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/latex/cairo-dock-dock-manager_8h.tex
1
 
\section{Référence du fichier /opt/cairo-dock/trunk/cairo-dock/src/cairo-dock-dock-manager.h}
2
 
\label{cairo-dock-dock-manager_8h}\index{/opt/cairo-dock/trunk/cairo-dock/src/cairo-dock-dock-manager.h@{/opt/cairo-dock/trunk/cairo-dock/src/cairo-dock-dock-manager.h}}
3
 
\subsection*{Fonctions}
4
 
\begin{CompactItemize}
5
 
\item 
6
 
void {\bf cairo\_\-dock\_\-initialize\_\-dock\_\-manager} (void)
7
 
\item 
8
 
{\bf CairoDock} $\ast$ {\bf cairo\_\-dock\_\-register\_\-dock} (const gchar $\ast$cDockName, {\bf CairoDock} $\ast$pDock)
9
 
\item 
10
 
void {\bf cairo\_\-dock\_\-unregister\_\-dock} (const gchar $\ast$cDockName)
11
 
\item 
12
 
void {\bf cairo\_\-dock\_\-reset\_\-docks\_\-table} (void)
13
 
\item 
14
 
const gchar $\ast$ {\bf cairo\_\-dock\_\-search\_\-dock\_\-name} ({\bf CairoDock} $\ast$pDock)
15
 
\item 
16
 
{\bf CairoDock} $\ast$ {\bf cairo\_\-dock\_\-search\_\-dock\_\-from\_\-name} (const gchar $\ast$cDockName)
17
 
\item 
18
 
{\bf Icon} $\ast$ {\bf cairo\_\-dock\_\-search\_\-icon\_\-pointing\_\-on\_\-dock} ({\bf CairoDock} $\ast$pDock, {\bf CairoDock} $\ast$$\ast$pParentDock)
19
 
\item 
20
 
{\bf CairoDockContainer} $\ast$ {\bf cairo\_\-dock\_\-search\_\-container\_\-from\_\-icon} ({\bf Icon} $\ast$icon)
21
 
\item 
22
 
void {\bf cairo\_\-dock\_\-update\_\-conf\_\-file\_\-with\_\-containers} (GKeyFile $\ast$pKeyFile, gchar $\ast$cDesktopFilePath)
23
 
\item 
24
 
void {\bf cairo\_\-dock\_\-search\_\-max\_\-decorations\_\-size} (int $\ast$iWidth, int $\ast$iHeight)
25
 
\item 
26
 
void {\bf cairo\_\-dock\_\-hide\_\-parent\_\-dock} ({\bf CairoDock} $\ast$pDock)
27
 
\item 
28
 
gboolean {\bf cairo\_\-dock\_\-hide\_\-child\_\-docks} ({\bf CairoDock} $\ast$pDock)
29
 
\item 
30
 
void {\bf cairo\_\-dock\_\-reload\_\-buffers\_\-in\_\-all\_\-docks} (void)
31
 
\item 
32
 
void {\bf cairo\_\-dock\_\-rename\_\-dock} (const gchar $\ast$cDockName, {\bf CairoDock} $\ast$pDock, const gchar $\ast$cNewName)
33
 
\item 
34
 
void {\bf cairo\_\-dock\_\-reset\_\-all\_\-views} (void)
35
 
\item 
36
 
void {\bf cairo\_\-dock\_\-set\_\-all\_\-views\_\-to\_\-default} (void)
37
 
\end{CompactItemize}
38
 
 
39
 
 
40
 
\subsection{Documentation des fonctions}
41
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_initialize_dock_manager@{cairo\_\-dock\_\-initialize\_\-dock\_\-manager}}
42
 
\index{cairo_dock_initialize_dock_manager@{cairo\_\-dock\_\-initialize\_\-dock\_\-manager}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
43
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-initialize\_\-dock\_\-manager (void)}\label{cairo-dock-dock-manager_8h_2b5fdbe43f5c55b54c69906a4ac314be}
44
 
 
45
 
 
46
 
Initialise la classe des docks. N'a aucun effet la 2eme fois. \index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_register_dock@{cairo\_\-dock\_\-register\_\-dock}}
47
 
\index{cairo_dock_register_dock@{cairo\_\-dock\_\-register\_\-dock}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
48
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf CairoDock}$\ast$ cairo\_\-dock\_\-register\_\-dock (const gchar $\ast$ {\em cDockName}, {\bf CairoDock} $\ast$ {\em pDock})}\label{cairo-dock-dock-manager_8h_31a579503c8f440c0130a4c3e82d9e1f}
49
 
 
50
 
 
51
 
Enregistre un dock dans la table des docks. \begin{Desc}
52
 
\item[Paramètres:]
53
 
\begin{description}
54
 
\item[{\em cDockName}]nom du dock. \item[{\em pDock}]le dock. \end{description}
55
 
\end{Desc}
56
 
\begin{Desc}
57
 
\item[Renvoie:]le dock portant ce nom s'il en existait deja un, sinon le dock qui a ete insere. \end{Desc}
58
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_unregister_dock@{cairo\_\-dock\_\-unregister\_\-dock}}
59
 
\index{cairo_dock_unregister_dock@{cairo\_\-dock\_\-unregister\_\-dock}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
60
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-unregister\_\-dock (const gchar $\ast$ {\em cDockName})}\label{cairo-dock-dock-manager_8h_3d33656011e57eb7c7215b84ae6792de}
61
 
 
62
 
 
63
 
Desenregistre un dock de la table des docks. \begin{Desc}
64
 
\item[Paramètres:]
65
 
\begin{description}
66
 
\item[{\em cDockName}]le nom du dock. \end{description}
67
 
\end{Desc}
68
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_reset_docks_table@{cairo\_\-dock\_\-reset\_\-docks\_\-table}}
69
 
\index{cairo_dock_reset_docks_table@{cairo\_\-dock\_\-reset\_\-docks\_\-table}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
70
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-reset\_\-docks\_\-table (void)}\label{cairo-dock-dock-manager_8h_a4541ce085111c634c9c947df0aa0098}
71
 
 
72
 
 
73
 
Vide la table des docks, en detruisant tous les docks et leurs icones. \index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_search_dock_name@{cairo\_\-dock\_\-search\_\-dock\_\-name}}
74
 
\index{cairo_dock_search_dock_name@{cairo\_\-dock\_\-search\_\-dock\_\-name}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
75
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const gchar$\ast$ cairo\_\-dock\_\-search\_\-dock\_\-name ({\bf CairoDock} $\ast$ {\em pDock})}\label{cairo-dock-dock-manager_8h_9989be0544735933310a229cae3c1f9a}
76
 
 
77
 
 
78
 
Cherche le nom d'un dock, en parcourant la table des docks jusqu'a trouver celui passe en entree. \begin{Desc}
79
 
\item[Paramètres:]
80
 
\begin{description}
81
 
\item[{\em pDock}]le dock. \end{description}
82
 
\end{Desc}
83
 
\begin{Desc}
84
 
\item[Renvoie:]le nom du dock, ou NULL si ce dock n'existe pas. \end{Desc}
85
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_search_dock_from_name@{cairo\_\-dock\_\-search\_\-dock\_\-from\_\-name}}
86
 
\index{cairo_dock_search_dock_from_name@{cairo\_\-dock\_\-search\_\-dock\_\-from\_\-name}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
87
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf CairoDock}$\ast$ cairo\_\-dock\_\-search\_\-dock\_\-from\_\-name (const gchar $\ast$ {\em cDockName})}\label{cairo-dock-dock-manager_8h_fb5a5ccee0196d5332226f4c548594bc}
88
 
 
89
 
 
90
 
Cherche un dock etant donne son nom. \begin{Desc}
91
 
\item[Paramètres:]
92
 
\begin{description}
93
 
\item[{\em cDockName}]le nom du dock. \end{description}
94
 
\end{Desc}
95
 
\begin{Desc}
96
 
\item[Renvoie:]le dock qui a ete enregistre sous ce nom, ou NULL si aucun ne correspond. \end{Desc}
97
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_search_icon_pointing_on_dock@{cairo\_\-dock\_\-search\_\-icon\_\-pointing\_\-on\_\-dock}}
98
 
\index{cairo_dock_search_icon_pointing_on_dock@{cairo\_\-dock\_\-search\_\-icon\_\-pointing\_\-on\_\-dock}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
99
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Icon}$\ast$ cairo\_\-dock\_\-search\_\-icon\_\-pointing\_\-on\_\-dock ({\bf CairoDock} $\ast$ {\em pDock}, {\bf CairoDock} $\ast$$\ast$ {\em pParentDock})}\label{cairo-dock-dock-manager_8h_0e45ba62e4c156427a36c43d01001797}
100
 
 
101
 
 
102
 
Cherche l'icone pointant sur un dock. Si plusieurs icones pointent sur ce dock, la premiere sera renvoyee. \begin{Desc}
103
 
\item[Paramètres:]
104
 
\begin{description}
105
 
\item[{\em pDock}]le dock. \item[{\em pParentDock}]si non NULL, sera renseigne avec le dock contenant l'icone. \end{description}
106
 
\end{Desc}
107
 
\begin{Desc}
108
 
\item[Renvoie:]l'icone pointant sur le dock. \end{Desc}
109
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_search_container_from_icon@{cairo\_\-dock\_\-search\_\-container\_\-from\_\-icon}}
110
 
\index{cairo_dock_search_container_from_icon@{cairo\_\-dock\_\-search\_\-container\_\-from\_\-icon}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
111
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf CairoDockContainer}$\ast$ cairo\_\-dock\_\-search\_\-container\_\-from\_\-icon ({\bf Icon} $\ast$ {\em icon})}\label{cairo-dock-dock-manager_8h_511c8944b1d87a6b40d4d675e2826ce9}
112
 
 
113
 
 
114
 
Cherche le container contenant l'icone donnee, en parcourant la liste des icones de tous les docks jusqu'a trouver celle passee en entree, ou en renvoyant son desklet dans le cas d'une applet. \begin{Desc}
115
 
\item[Paramètres:]
116
 
\begin{description}
117
 
\item[{\em icon}]l'icone. \end{description}
118
 
\end{Desc}
119
 
\begin{Desc}
120
 
\item[Renvoie:]le container contenant cette icone, ou NULL si aucun n'a ete trouve. \end{Desc}
121
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_update_conf_file_with_containers@{cairo\_\-dock\_\-update\_\-conf\_\-file\_\-with\_\-containers}}
122
 
\index{cairo_dock_update_conf_file_with_containers@{cairo\_\-dock\_\-update\_\-conf\_\-file\_\-with\_\-containers}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
123
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-update\_\-conf\_\-file\_\-with\_\-containers (GKeyFile $\ast$ {\em pKeyFile}, gchar $\ast$ {\em cDesktopFilePath})}\label{cairo-dock-dock-manager_8h_235901a0980eedfdcc03f2ec54963310}
124
 
 
125
 
 
126
 
Met a jour un fichier .desktop avec la liste des docks dans le champ \char`\"{}Container\char`\"{}. \begin{Desc}
127
 
\item[Paramètres:]
128
 
\begin{description}
129
 
\item[{\em pKeyFile}]fichier de conf ouvert. \item[{\em cDesktopFilePath}]chemin du fichier de conf. \end{description}
130
 
\end{Desc}
131
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_search_max_decorations_size@{cairo\_\-dock\_\-search\_\-max\_\-decorations\_\-size}}
132
 
\index{cairo_dock_search_max_decorations_size@{cairo\_\-dock\_\-search\_\-max\_\-decorations\_\-size}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
133
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-search\_\-max\_\-decorations\_\-size (int $\ast$ {\em iWidth}, int $\ast$ {\em iHeight})}\label{cairo-dock-dock-manager_8h_6979dac261c0c7c8178fc9c654651254}
134
 
 
135
 
 
136
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_hide_parent_dock@{cairo\_\-dock\_\-hide\_\-parent\_\-dock}}
137
 
\index{cairo_dock_hide_parent_dock@{cairo\_\-dock\_\-hide\_\-parent\_\-dock}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
138
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-hide\_\-parent\_\-dock ({\bf CairoDock} $\ast$ {\em pDock})}\label{cairo-dock-dock-manager_8h_883300022a42568b3565b9135e063ba3}
139
 
 
140
 
 
141
 
Cache recursivement tous les dock peres d'un dock. \begin{Desc}
142
 
\item[Paramètres:]
143
 
\begin{description}
144
 
\item[{\em pDock}]le dock fils. \end{description}
145
 
\end{Desc}
146
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_hide_child_docks@{cairo\_\-dock\_\-hide\_\-child\_\-docks}}
147
 
\index{cairo_dock_hide_child_docks@{cairo\_\-dock\_\-hide\_\-child\_\-docks}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
148
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}gboolean cairo\_\-dock\_\-hide\_\-child\_\-docks ({\bf CairoDock} $\ast$ {\em pDock})}\label{cairo-dock-dock-manager_8h_5f3268886844cf7c952d229c6d9b3782}
149
 
 
150
 
 
151
 
Cache recursivement tous les sous-docks fils d'un dock donne. \begin{Desc}
152
 
\item[Paramètres:]
153
 
\begin{description}
154
 
\item[{\em pDock}]le dock parent. \end{description}
155
 
\end{Desc}
156
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_reload_buffers_in_all_docks@{cairo\_\-dock\_\-reload\_\-buffers\_\-in\_\-all\_\-docks}}
157
 
\index{cairo_dock_reload_buffers_in_all_docks@{cairo\_\-dock\_\-reload\_\-buffers\_\-in\_\-all\_\-docks}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
158
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-reload\_\-buffers\_\-in\_\-all\_\-docks (void)}\label{cairo-dock-dock-manager_8h_aba395a26fa90f18d3264e879b3cc141}
159
 
 
160
 
 
161
 
Recharge les buffers de toutes les icones de tous les docks. \index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_rename_dock@{cairo\_\-dock\_\-rename\_\-dock}}
162
 
\index{cairo_dock_rename_dock@{cairo\_\-dock\_\-rename\_\-dock}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
163
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-rename\_\-dock (const gchar $\ast$ {\em cDockName}, {\bf CairoDock} $\ast$ {\em pDock}, const gchar $\ast$ {\em cNewName})}\label{cairo-dock-dock-manager_8h_2c0b1b0ae6feee6e9c2527f4efded7ec}
164
 
 
165
 
 
166
 
Renomme un dock. Met a jour le nom du container de ses icones. \begin{Desc}
167
 
\item[Paramètres:]
168
 
\begin{description}
169
 
\item[{\em cDockName}]nom du dock. \item[{\em pDock}]le dock. \item[{\em cNewName}]son nouveau nom. \end{description}
170
 
\end{Desc}
171
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_reset_all_views@{cairo\_\-dock\_\-reset\_\-all\_\-views}}
172
 
\index{cairo_dock_reset_all_views@{cairo\_\-dock\_\-reset\_\-all\_\-views}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
173
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-reset\_\-all\_\-views (void)}\label{cairo-dock-dock-manager_8h_1d16b5cb3e1c382cfe573b541da5ad85}
174
 
 
175
 
 
176
 
\index{cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}!cairo_dock_set_all_views_to_default@{cairo\_\-dock\_\-set\_\-all\_\-views\_\-to\_\-default}}
177
 
\index{cairo_dock_set_all_views_to_default@{cairo\_\-dock\_\-set\_\-all\_\-views\_\-to\_\-default}!cairo-dock-dock-manager.h@{cairo-dock-dock-manager.h}}
178
 
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void cairo\_\-dock\_\-set\_\-all\_\-views\_\-to\_\-default (void)}\label{cairo-dock-dock-manager_8h_734dac3576b37663ec1519bf1f4fae14}
179
 
 
180