Brief documentation on wAppIconFor() and wWindowFor().
authorIain Patterson <wm@iain.cx>
Tue, 30 Oct 2012 16:10:14 +0000 (30 09:10 -0700)
committerCarlos R. Mafra <crmafra@gmail.com>
Tue, 30 Oct 2012 16:21:44 +0000 (30 16:21 +0000)
Brief comment on what wAppIconFor() and wWindowFor() do, as it
may not be immediately obvious.

Given a raw X11 Window they will find the AppIcon (or WWindow,
respectively) associated with that window.  Thus they can map an
X11 object to a Window Maker internal object.

src/appicon.c
src/window.c

index 6be3057..77c5e30 100644 (file)
@@ -1018,6 +1018,7 @@ static void remove_from_appicon_list(WScreen *scr, WAppIcon *appicon)
        appicon->next = NULL;
 }
 
+/* Return the AppIcon associated with a given (Xlib) Window. */
 WAppIcon *wAppIconFor(Window window)
 {
        WObjDescriptor *desc;
index 4691021..199613c 100644 (file)
@@ -141,6 +141,7 @@ static void appearanceObserver(void *self, WMNotification * notif)
 }
 
 
+/* Return the WWindow associated with a given (Xlib) Window. */
 WWindow *wWindowFor(Window window)
 {
        WObjDescriptor *desc;