/usr/include/cairo-dock/gldit/cairo-dock-icon-factory.h is in libgldi-dev 3.0.0.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | /*
* This file is a part of the Cairo-Dock project
*
* Copyright : (C) see the 'copyright' file.
* E-mail : see the 'copyright' file.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __CAIRO_DOCK_ICON_FACTORY__
#define __CAIRO_DOCK_ICON_FACTORY__
#include <glib.h>
#include "cairo-dock-struct.h"
#include "cairo-dock-object.h"
G_BEGIN_DECLS
/**
*@file cairo-dock-icon-factory.h This class defines the items contained in containers : Icons.
* An icon can either be:
* - a launcher (it has a command, a class, and possible an X window ID)
* - an appli (it has a X window ID and a class, no command)
* - an applet (it has a module instance and no command, possibly a class)
* - a container (it has a sub-dock and no class nor command)
* - a class icon (it has a bsub-dock and a class, but no command nor X ID)
* - a separator (it has nothing)
*
* The class defines the methods used to create a generic Icon and to load its various buffers.
* Specialized Icons are created by the corresponding factory.
*/
/// Definition of the type of icons.
typedef enum {
CAIRO_DOCK_ICON_TYPE_LAUNCHER = 0,
CAIRO_DOCK_ICON_TYPE_CONTAINER,
CAIRO_DOCK_ICON_TYPE_SEPARATOR,
CAIRO_DOCK_ICON_TYPE_FILE,
CAIRO_DOCK_ICON_TYPE_CLASS_CONTAINER,
CAIRO_DOCK_ICON_TYPE_APPLI,
CAIRO_DOCK_ICON_TYPE_APPLET,
CAIRO_DOCK_ICON_TYPE_OTHER,
CAIRO_DOCK_NB_ICON_TYPES
} CairoDockIconTrueType;
/// Available groups of icons.
typedef enum {
CAIRO_DOCK_LAUNCHER = 0, // launchers and applets, and applis if mixed
CAIRO_DOCK_SEPARATOR12,
CAIRO_DOCK_APPLI,
CAIRO_DOCK_NB_GROUPS
} CairoDockIconGroup;
/// Animation state of an icon, sorted by priority.
typedef enum {
CAIRO_DOCK_STATE_REST = 0,
CAIRO_DOCK_STATE_MOUSE_HOVERED,
CAIRO_DOCK_STATE_CLICKED,
CAIRO_DOCK_STATE_AVOID_MOUSE,
CAIRO_DOCK_STATE_FOLLOW_MOUSE,
CAIRO_DOCK_STATE_REMOVE_INSERT,
CAIRO_DOCK_NB_STATES
} CairoDockAnimationState;
/// Icon's interface
struct _IconInterface {
/// function that loads the icon surface (and optionnally texture).
void (*load_image) (Icon *icon);
/// function called when the icon is deleted from the current theme.
gboolean (*on_delete) (Icon *icon);
/// function called when the user drag something over the icon for more than 500ms.
void (*action_on_drag_hover) (Icon *icon);
};
/// Definition of an Icon.
struct _Icon {
//\____________ Definition.
/// object
GldiObject object;
gpointer pDataSlot[CAIRO_DOCK_NB_DATA_SLOT];
/// type of the icon.
CairoDockIconTrueType iTrueType;
/// group of the icon.
CairoDockIconGroup iGroup;
/// interface
IconInterface iface;
//\____________ properties.
// generic.
/// Name of the icon.
gchar *cName;
/// Short info displayed on the icon (few characters).
gchar *cQuickInfo;
/// name or path of an image displayed on the icon.
gchar *cFileName;
/// Class of application the icon will be bound to.
gchar *cClass;
/// name of the dock the icon belongs to (NULL means it's not currently inside a dock).
gchar *cParentDockName;
/// Sub-dock the icon is pointing to.
CairoDock *pSubDock;
/// Order of the icon amongst the other icons of its group.
gdouble fOrder;
gint iSpecificDesktop;
gint iSubdockViewType;
/// a hint to indicate the icon should be kept static (no animation like bouncing).
gboolean bStatic;
/// a flag that allows the icon to be always visible, even with the dock is hidden.
gboolean bAlwaysVisible;
gboolean bIsDemandingAttention;
CairoDataRenderer *pDataRenderer;
CairoDockTransition *pTransition;
CairoDockAnimationState iAnimationState;
/// Whether the icon is currently pointed or not.
gboolean bPointed;
gdouble fInsertRemoveFactor;
// Launcher.
gchar *cDesktopFileName; // nom (et non pas chemin) du fichier .desktop
gchar *cCommand;
gchar *cWorkingDirectory;
gchar *cBaseURI;
gint iVolumeID;
// Appli.
Window Xid;
gboolean bIsHidden;
gboolean bIsFullScreen;
gboolean bIsMaximized;
gboolean bHasIndicator;
GtkAllocation windowGeometry;
gint iNumDesktop;
gint iViewPortX, iViewPortY;
gint iStackOrder;
gint iLastCheckTime;
gchar *cInitialName;
gchar *cLastAttentionDemand;
gint iAge; // age of the window (a mere growing integer).
Pixmap iBackingPixmap;
//Damage iDamageHandle;
// Applet.
CairoDockModuleInstance *pModuleInstance;
CairoDockModuleInstance *pAppletOwner;
//\____________ Buffers.
gdouble fWidth, fHeight; // taille dans le container.
gint iImageWidth, iImageHeight; // taille de la surface/texture telle qu'elle a ete creee.
cairo_surface_t* pIconBuffer;
GLuint iIconTexture;
cairo_surface_t* pReflectionBuffer_deprecated;
gint iTextWidth, iTextHeight;
cairo_surface_t* pTextBuffer;
GLuint iLabelTexture;
gint iQuickInfoWidth, iQuickInfoHeight;
cairo_surface_t* pQuickInfoBuffer;
GLuint iQuickInfoTexture;
//\____________ Parametres de dessin, definis par la vue/les animations.
gdouble fXMin, fXMax; // Abscisse extremale gauche/droite que the icon atteindra (variable avec la vague).
gdouble fXAtRest; // Abscisse de the icon au repos.
gdouble fPhase; // Phase de the icon (entre -pi et piconi).
gdouble fX, fY; // Abscisse/Ordonnee temporaire du bord haut-gauche de l'image de the icon.
gdouble fScale;
gdouble fDrawX, fDrawY;
gdouble fWidthFactor, fHeightFactor;
gdouble fAlpha;
gdouble fDeltaYReflection; // Decalage en ordonnees du reflet (rebond).
gdouble fOrientation; // par rapport a la verticale Oz
gint iRotationX; // Rotation autour de l'axe Ox
gint iRotationY; // Rotation autour de l'axe Oy
gdouble fReflectShading;
gdouble fGlideOffset; // decalage pour le glissement des icons.
gint iGlideDirection; // direction dans laquelle glisse the icon.
gdouble fGlideScale; // echelle d'adaptation au glissement.
gboolean bBeingRemovedByCairo; // devrait etre dans pDataSlot...
guint iSidRedrawSubdockContent;
guint iSidLoadImage;
guint iSidDoubleClickDelay;
/// container where the icon is currently.
CairoContainer *pContainer;
gint iNbDoubleClickListeners;
gchar **pMimeTypes;
gint iHideLabel;
gchar *cWmClass;
GList *pOverlays;
gdouble *pHiddenBgColor;
gint iThumbnailX, iThumbnailY; // X icon geometry for apps
gint iThumbnailWidth, iThumbnailHeight;
gboolean bDamaged; // TRUE when the icon couldn't draw its surface, because the Gl context was not yet ready.
gpointer reserved[1];
};
typedef void (*CairoIconContainerLoadFunc) (void);
typedef void (*CairoIconContainerUnloadFunc) (void);
typedef void (*CairoIconContainerRenderFunc) (Icon *pIcon, CairoContainer *pContainer, int w, int h, cairo_t *pCairoContext);
typedef void (*CairoIconContainerRenderOpenGLFunc) (Icon *pIcon, CairoContainer *pContainer, int w, int h);
/// Definition of an Icon container (= an icon holding a sub-dock) renderer.
struct _CairoIconContainerRenderer {
CairoIconContainerLoadFunc load;
CairoIconContainerUnloadFunc unload;
CairoIconContainerRenderFunc render;
CairoIconContainerRenderOpenGLFunc render_opengl;
};
#define CAIRO_DOCK_ICON_TYPE_IS_LAUNCHER(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_LAUNCHER)
#define CAIRO_DOCK_ICON_TYPE_IS_FILE(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_FILE)
#define CAIRO_DOCK_ICON_TYPE_IS_CONTAINER(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_CONTAINER)
#define CAIRO_DOCK_ICON_TYPE_IS_SEPARATOR(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_SEPARATOR)
#define CAIRO_DOCK_ICON_TYPE_IS_CLASS_CONTAINER(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_CLASS_CONTAINER)
#define CAIRO_DOCK_ICON_TYPE_IS_APPLI(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_APPLI)
#define CAIRO_DOCK_ICON_TYPE_IS_APPLET(icon) (icon != NULL && (icon)->iTrueType == CAIRO_DOCK_ICON_TYPE_APPLET)
/** TRUE if the icon holds a window.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_APPLI(icon) (icon != NULL && (icon)->Xid != 0)
/** TRUE if the icon holds an instance of a module.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_APPLET(icon) (icon != NULL && (icon)->pModuleInstance != NULL)
/** TRUE if the icon is an icon pointing on the sub-dock of a class.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_MULTI_APPLI(icon) (\
( CAIRO_DOCK_ICON_TYPE_IS_LAUNCHER (icon)\
|| CAIRO_DOCK_ICON_TYPE_IS_CLASS_CONTAINER (icon)\
|| (CAIRO_DOCK_ICON_TYPE_IS_APPLET (icon) && icon->cClass != NULL) )\
&& icon->pSubDock != NULL)
/** TRUE if the icon is an automatic separator.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_AUTOMATIC_SEPARATOR(icon) (CAIRO_DOCK_ICON_TYPE_IS_SEPARATOR (icon) && (icon)->cDesktopFileName == NULL)
/** TRUE if the icon is a separator added by the user.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_USER_SEPARATOR(icon) (CAIRO_DOCK_ICON_TYPE_IS_SEPARATOR (icon) && (icon)->cDesktopFileName != NULL)
/**
*TRUE if the icon is an icon d'appli only.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_NORMAL_APPLI(icon) (CAIRO_DOCK_IS_APPLI (icon) && CAIRO_DOCK_ICON_TYPE_IS_APPLI (icon))
/**
*TRUE if the icon is an icon d'applet detachable en desklet.
*@param icon an icon.
*/
#define CAIRO_DOCK_IS_DETACHABLE_APPLET(icon) (CAIRO_DOCK_IS_APPLET (icon) && (icon)->pModuleInstance->bCanDetach)
/** Create an empty icon.
*@return the newly allocated icon object.
*/
Icon *cairo_dock_new_icon (void);
void cairo_dock_free_icon_buffers (Icon *icon);
/* Cree la surface de reflection d'une icone (pour cairo).
*@param pIcon l'icone.
*@param pContainer le container de l'icone.
*/
void cairo_dock_add_reflection_to_icon (Icon *pIcon, CairoContainer *pContainer);
/**Fill the image buffer (surface & texture) of a given icon, according to its type. Set its size if necessary, and fills the reflection buffer for cairo.
*@param icon the icon.
*@param pContainer its container.
*/
void cairo_dock_load_icon_image (Icon *icon, CairoContainer *pContainer);
/**Fill the label buffer (surface & texture) of a given icon, according to a text description.
*@param icon the icon.
*@param pTextDescription desctiption of the text rendering.
*/
void cairo_dock_load_icon_text (Icon *icon, CairoDockLabelDescription *pTextDescription);
/**Fill the quick-info buffer (surface & texture) of a given icon, according to a text description.
*@param icon the icon.
*@param pTextDescription desctiption of the text rendering.
*/
void cairo_dock_load_icon_quickinfo (Icon *icon, CairoDockLabelDescription *pTextDescription);
/** Fill all the buffers (surfaces & textures) of a given icon, according to its type. Set its size accordingly, and fills the reflection buffer for cairo. Label and quick-info are loaded with the current global text description.
*@param pIcon the icon.
*@param pContainer its container.
*/
void cairo_dock_load_icon_buffers (Icon *pIcon, CairoContainer *pContainer);
void cairo_dock_trigger_load_icon_buffers (Icon *pIcon);
void cairo_dock_reload_icon_image (Icon *icon, CairoContainer *pContainer);
void cairo_dock_draw_subdock_content_on_icon (Icon *pIcon, CairoDock *pDock);
#define cairo_dock_set_subdock_content_renderer(pIcon, view) (pIcon)->iSubdockViewType = view
G_END_DECLS
#endif
|