JWM Source Documentation
Functions
dock.h File Reference

Dock tray component (used for system notifications). More...

Go to the source code of this file.

Functions

struct TrayComponentTypeCreateDock (int width)
 Create a dock to be used for notifications.
 
void HandleDockEvent (const XClientMessageEvent *event)
 Handle a client message sent to the dock window.
 
char HandleDockDestroy (Window win)
 Handle a destroy event.
 
char HandleDockSelectionClear (const XSelectionClearEvent *event)
 Handle a selection clear event.
 
char HandleDockResizeRequest (const XResizeRequestEvent *event)
 Handle a resize request.
 
char HandleDockConfigureRequest (const XConfigureRequestEvent *event)
 Handle a configure request.
 
char HandleDockReparentNotify (const XReparentEvent *event)
 Handle a reparent notify event.
 
void InitializeDock (void)
 Initialize dock data.
 
void StartupDock (void)
 Startup the dock.
 
void ShutdownDock (void)
 Shutdown the dock.
 
void DestroyDock (void)
 Destroy dock data.
 

Detailed Description

Dock tray component (used for system notifications).

Author
Joe Wingbermuehle
Date
2006

Definition in file dock.h.

Function Documentation

struct TrayComponentType* CreateDock ( int  width)
read

Create a dock to be used for notifications.

Note that only one dock can be created.

Parameters
widthThe width of an item in the dock.

Definition at line 145 of file dock.c.

References _, Allocate, DockType::cp, Create(), TrayComponentType::Create, CreateTrayComponent(), dock, DockType::itemSize, JUNLIKELY, DockType::nodes, TrayComponentType::object, TrayComponentType::requestedHeight, TrayComponentType::requestedWidth, Resize(), TrayComponentType::Resize, SetSize(), TrayComponentType::SetSize, Warning(), and DockType::window.

Referenced by ParseDock().

void DestroyDock ( void  )

Destroy dock data.

Definition at line 136 of file dock.c.

References Release.

Referenced by Destroy().

char HandleDockConfigureRequest ( const XConfigureRequestEvent *  event)

Handle a configure request.

Parameters
eventThe configure request event.
Returns
1 if handled, 0 otherwise.

Definition at line 301 of file dock.c.

References Assert, DockNode::next, DockType::nodes, UpdateDock(), and DockNode::window.

Referenced by HandleConfigureRequest().

char HandleDockDestroy ( Window  win)

Handle a destroy event.

Parameters
winThe window that was destroyed.
Returns
1 if handled, 0 otherwise.

Definition at line 417 of file dock.c.

References DockType::cp, GetDockSize(), DockNode::next, DockType::nodes, Release, TrayComponentType::requestedHeight, TrayComponentType::requestedWidth, ResizeTray(), TrayComponentType::tray, and DockNode::window.

Referenced by HandleDestroyNotify().

void HandleDockEvent ( const XClientMessageEvent *  event)

Handle a client message sent to the dock window.

Parameters
eventThe event.

Definition at line 262 of file dock.c.

References Assert, Debug(), DockWindow(), SYSTEM_TRAY_BEGIN_MESSAGE, SYSTEM_TRAY_CANCEL_MESSAGE, and SYSTEM_TRAY_REQUEST_DOCK.

Referenced by HandleClientMessage().

char HandleDockReparentNotify ( const XReparentEvent *  event)

Handle a reparent notify event.

Parameters
eventThe reparent notify event.
Returns
1 if handled, 0 otherwise.

Definition at line 324 of file dock.c.

References Assert, DockType::cp, DockNode::needs_reparent, DockNode::next, DockType::nodes, UpdateDock(), DockNode::window, and TrayComponentType::window.

Referenced by WaitForEvent().

char HandleDockResizeRequest ( const XResizeRequestEvent *  event)

Handle a resize request.

Parameters
eventThe resize request event.
Returns
1 if handled, 0 otherwise.

Definition at line 280 of file dock.c.

References Assert, DockNode::next, DockType::nodes, UpdateDock(), and DockNode::window.

Referenced by WaitForEvent().

char HandleDockSelectionClear ( const XSelectionClearEvent *  event)

Handle a selection clear event.

Parameters
eventThe selection clear event.
Returns
1 if handled, 0 otherwise.

Definition at line 363 of file dock.c.

References Debug(), dockAtom, and owner.

Referenced by HandleSelectionClear().

void InitializeDock ( void  )

Initialize dock data.

Definition at line 64 of file dock.c.

References owner.

Referenced by Initialize().

void ShutdownDock ( void  )
void StartupDock ( void  )

joewing.net / Projects / JWM