Menu
▾
▴
[Interfacewm-cvs] interfacewm IWMClient.h,1.13,1.14 IWMClient.m,1.22,1.23 IWMIcon.h,1.1,1.2 IWMResizebar.h,1.2,1.3 IWMScreen.h,1.6,1.7 IWMTheme.h,1.6,1.7 IWMWindow.h,1.9,1.10 IWMWindowManager.h,1.18,1.19
Update of /cvsroot/interfacewm/interfacewm
In directory sc8-pr-cvs1:/tmp/cvs-serv18150
Modified Files:
IWMClient.h IWMClient.m IWMIcon.h IWMResizebar.h IWMScreen.h
IWMTheme.h IWMWindow.h IWMWindowManager.h
Log Message:
modified headerdocs, some minor cleanup
Index: IWMClient.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMClient.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** IWMClient.h 28 Oct 2003 04:34:49 -0000 1.13
--- IWMClient.h 29 Oct 2003 04:08:02 -0000 1.14
***************
*** 34,47 ****
#include <Foundation/NSGeometry.h>
- #define MAXWINDOWS 10 //11
-
- enum {
- PARENT, WINDOW, TITLEBAR, CLOSE_BUTTON, MIN_BUTTON, //MAX_BUTTON,
- RESIZEBAR, LEFT_GRIP, RIGHT_GRIP, ICON, TRANSIENT
- };
-
@class IWMWindowManager, IWMScreen, IWMWindow, IWMTitlebar, IWMResizebar, IWMIcon;
@class NSMutableDictionary;
@interface IWMClient : NSObject <IWMClientProtocol>
{
--- 34,44 ----
#include <Foundation/NSGeometry.h>
@class IWMWindowManager, IWMScreen, IWMWindow, IWMTitlebar, IWMResizebar, IWMIcon;
@class NSMutableDictionary;
+ /*!
+ * @class IWMClient
+ * An application's client structure
+ */
@interface IWMClient : NSObject <IWMClientProtocol>
{
***************
*** 95,105 ****
--- 92,123 ----
*==========================================================================*/
+ /*!
+ * @method initWithWindow:onScreen:
+ * @discussion Designated initializer.
+ * @param aWindow The application X window
+ * @param aScreen The screen number
+ */
- initWithWindow:(Window)aWindow onScreen:(int)aScreenNumber;
+ /*!
+ * @method initializeDimentions
+ * @discussion Initializes the client's size and origin
+ */
- initializeDimentions;
+
+ /*!
+ * @method initializeDecorations
+ * @discussion Initializes the client's decor (titlebar, resizebar)
+ */
- initializeDecorations;
+
- initializeDecorations_NET;
- initializeDecorations_MOTIF;
+ /*!
+ * @method initializeParentWindow
+ * @discussion Initializes the client's parent window, which contains
+ * the application window, titlebar and resizebar
+ */
- initializeParentWindow;
***************
*** 108,113 ****
--- 126,143 ----
*==========================================================================*/
+ /*!
+ * @method drawOutline
+ * @discussion Draws the outline of a client during resizing/movement
+ */
- (void)drawOutline;
+
+ /*!
+ * @method windowForXWindow:
+ * @discussion Returns the IWMWindow object wrapping the provided X window if
+ * it is present in the client's window hierarchy.
+ * @param aWindow An X Window
+ */
- (IWMWindow *)windowForXWindow:(Window)aWindow;
+
- (void)sendProtocol:(Atom)atom;
***************
*** 116,123 ****
--- 146,174 ----
*==========================================================================*/
+ /*!
+ * @method move
+ * @discussion Moves the client
+ */
- (void)move;
+
+ /*!
+ * @method moveWithMouseUntilButtonRelease
+ * @discussion Continues client movement until the mouse button is released
+ */
- (void)moveWithMouseUntilButtonRelease;
+ /*!
+ * @method resize:
+ * @discussion Resizes a client. If <i>resizeWidth</i> is <b>YES</b>, then
+ * the resizing will affect both width and height, otherwise, only height.
+ * @param resizeWidth
+ */
- (void)resize:(BOOL)resizeWidth;
+
+ /*!
+ * @method resizeWithMouseUntilButtonRelease:
+ * @discussion Continues client resizing until the mouse button is released.
+ * @param resizeWidth
+ */
- (void)resizeWithMouseUntilButtonRelease:(BOOL)resizeWidth;
- (void)resizeWithMouseMotionTo:(int)xValue :(int)yValue;
***************
*** 203,211 ****
#ifdef SHAPE
-
- (int) shape;
- (void) setShape:(int)shape;
!
! #endif /* SHAPE */
- (BOOL)hasBorder;
--- 254,260 ----
#ifdef SHAPE
- (int) shape;
- (void) setShape:(int)shape;
! #endif
- (BOOL)hasBorder;
***************
*** 222,229 ****
- (NSString *)description;
!
! /*==========================================================================*
! XClientMessageEvent Methods
! *==========================================================================*/
@end
--- 271,275 ----
- (NSString *)description;
! - (void)dealloc;
@end
Index: IWMClient.m
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMClient.m,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -d -r1.22 -r1.23
*** IWMClient.m 28 Oct 2003 04:34:49 -0000 1.22
--- IWMClient.m 29 Oct 2003 04:08:02 -0000 1.23
***************
*** 727,740 ****
[window unhide];
! if (decor.titlebar)
! {
[titlebar unhide];
! }
! if (decor.resizebar)
! {
[resizebar unhide];
- //[leftGrip unhide];
- //[rightGrip unhide];
- }
[self setWMState:NormalState]; // XXX boo
--- 727,735 ----
[window unhide];
! if (decor.titlebar && titlebar)
[titlebar unhide];
!
! if (decor.resizebar && resizebar)
[resizebar unhide];
[self setWMState:NormalState]; // XXX boo
***************
*** 867,876 ****
[parent autorelease];
parent = [aParent retain];
- //windows.parent = [parent xWindow];
}
- (IWMTitlebar *)titlebar
{
! if (decor.titlebar)
return titlebar;
--- 862,870 ----
[parent autorelease];
parent = [aParent retain];
}
- (IWMTitlebar *)titlebar
{
! if (decor.titlebar && titlebar)
return titlebar;
***************
*** 884,889 ****
if (decor.titlebar)
{
- //IWMWindow *button = nil;
-
[titlebar autorelease];
titlebar = [aTitlebar retain];
--- 878,881 ----
***************
*** 895,901 ****
{
if (decor.titlebar)
- {
return [[self screen] titlebarHeight];
- }
return 0;
--- 887,891 ----
***************
*** 904,911 ****
- (IWMResizebar *)resizebar
{
! if (decor.resizebar)
! {
return resizebar;
- }
return nil;
--- 894,899 ----
- (IWMResizebar *)resizebar
{
! if (decor.resizebar && resizebar)
return resizebar;
return nil;
***************
*** 918,928 ****
if (decor.resizebar)
{
- int xValue = GRIP_WIDTH;
- int yValue = [self height] - [self resizebarHeight];
-
[resizebar autorelease];
resizebar = [aResizebar retain];
! //windows.resizebar = [resizebar xWindow];
! [resizebar setInto:parent x:xValue y:yValue];
}
}
--- 906,912 ----
if (decor.resizebar)
{
[resizebar autorelease];
resizebar = [aResizebar retain];
! [resizebar setInto:parent x:GRIP_WIDTH y:([self height] - [self resizebarHeight])];
}
}
***************
*** 1093,1098 ****
{
return [parent x];
-
- //return app_dimentions.x;
}
--- 1077,1080 ----
***************
*** 1105,1110 ****
{
return [parent y];
-
- //return app_dimentions.y;
}
--- 1087,1090 ----
***************
*** 1368,1378 ****
if (decor.titlebar)
- {
[titlebar hide];
! }
if (decor.resizebar)
- {
[resizebar hide];
- }
[self setWMState:IconicState];
--- 1348,1355 ----
if (decor.titlebar)
[titlebar hide];
!
if (decor.resizebar)
[resizebar hide];
[self setWMState:IconicState];
Index: IWMIcon.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMIcon.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** IWMIcon.h 28 Oct 2003 04:34:49 -0000 1.1
--- IWMIcon.h 29 Oct 2003 04:08:03 -0000 1.2
***************
*** 27,30 ****
--- 27,34 ----
#include "IWMWindow.h"
+ /*!
+ * @class IWMIcon
+ * An icon representing a client window
+ */
@interface IWMIcon : IWMWindow
{
Index: IWMResizebar.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMResizebar.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** IWMResizebar.h 28 Oct 2003 02:44:35 -0000 1.2
--- IWMResizebar.h 29 Oct 2003 04:08:03 -0000 1.3
***************
*** 29,32 ****
--- 29,36 ----
@class IWMClient;
+ /*!
+ * @class IWMResizebar
+ * Representation of a client's resizebar, including grips
+ */
@interface IWMResizebar : IWMWindow
{
Index: IWMScreen.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMScreen.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** IWMScreen.h 8 Oct 2003 04:31:44 -0000 1.6
--- IWMScreen.h 29 Oct 2003 04:08:03 -0000 1.7
***************
*** 39,42 ****
--- 39,46 ----
@class NSMutableArray;
+ /*!
+ * @class IWMScreen
+ * Representation of a screen, or virtual desktop
+ */
@interface IWMScreen : NSObject
{
***************
*** 146,150 ****
--- 150,165 ----
*==========================================================================*/
+ /*!
+ * @method setTheme:
+ * @discussion Sets the theme of the screen to the provided IWMTheme
+ * @param aTheme An IWMTheme
+ */
- (void)setTheme:(IWMTheme *)aTheme;
+
+ /*!
+ * @method setScreenBackgroundImage:
+ * @discussion Sets the background image of the screen
+ * @param anImage An IWMImage
+ */
- (void)setScreenBackgroundImage:(IWMImage *)anImage;
***************
*** 161,178 ****
--- 176,236 ----
- (int)textWidthForString:(NSString *)aString;
+
+ /*!
+ * @method drawCenteredText:
+ * @discussion Draws the provided text in the center of the screen
+ * @param aString The text to draw
+ */
- (void)drawCenteredText:(NSString *)aString;
+
- (void)drawRectangleWithWidth:(int)width height:(int)height x:(int)xValue
y:(int)yValue;
- (Window)rootXWindow;
+
+ /*!
+ * @method rootWindow
+ * @discussion Returns the IWMWindow representing the screen's root window
+ */
- (IWMWindow *)rootWindow;
+
+ /*!
+ * @method theme
+ * @discussion Returns the screen's current theme
+ */
- (IWMTheme *)theme;
+
+ /*!
+ * @method screenNumber
+ * @discussion Returns the screen's screen number
+ */
- (int)screenNumber;
+
+ /*!
+ * @method depth
+ * @discussion Returns the screen's depth
+ */
- (int)depth;
+
+ /*!
+ * @method width
+ * @discussion Returns the screen's width
+ */
- (int)width;
+
+ /*!
+ * @method height
+ * @discussion Returns the screen's height
+ */
- (int)height;
- (Colormap)colormap;
- (RContext *)rcontext;
+
+ /*!
+ * @method clientArray
+ * @discussion Returns an array of all IWMClient's on the screen
+ */
- (NSMutableArray *)clientArray;
+
- (Cursor)normalCursor;
- (Cursor)moveCursor;
Index: IWMTheme.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMTheme.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** IWMTheme.h 22 Apr 2003 17:39:41 -0000 1.6
--- IWMTheme.h 29 Oct 2003 04:08:03 -0000 1.7
***************
*** 40,43 ****
--- 40,46 ----
@class NSBundle;
+ /*!
+ * @class IWMTheme
+ */
@interface IWMTheme : NSObject
{
Index: IWMWindow.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMWindow.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** IWMWindow.h 28 Oct 2003 04:34:49 -0000 1.9
--- IWMWindow.h 29 Oct 2003 04:08:03 -0000 1.10
***************
*** 157,161 ****
--- 157,170 ----
- (void)setInto:(IWMWindow *)aParent x:(int)xValue y:(int)yValue;
+ /*!
+ * @method hide
+ * @discussion Hides the window
+ */
- (void)hide;
+
+ /*!
+ * @method unhide
+ * @discussion Unhides the window
+ */
- (void)unhide;
- (void)raise;
***************
*** 164,167 ****
--- 173,180 ----
- (void) destroy;
+ /*!
+ * @method name
+ * @discussion Returns the name of the window
+ */
- (NSString *)name;
- (void)setName:(NSString *)name;
***************
*** 220,224 ****
--- 233,247 ----
data:(unsigned char *)data elements:(int)elements;
+ /*!
+ * @method windowType
+ * @discussion Returns the type of the window
+ */
- (Atom)windowType;
+
+ /*!
+ * @method setWindowType:
+ * @discussion Sets the type of the window
+ * @param aType An atom identifying the window type
+ */
- (void)setWindowType:(Atom)aType;
Index: IWMWindowManager.h
===================================================================
RCS file: /cvsroot/interfacewm/interfacewm/IWMWindowManager.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -d -r1.18 -r1.19
*** IWMWindowManager.h 28 Oct 2003 01:08:10 -0000 1.18
--- IWMWindowManager.h 29 Oct 2003 04:08:03 -0000 1.19
***************
*** 35,38 ****
--- 35,42 ----
@class NSString, NSMutableArray, NSMutableDictionary, NSNotification;
+ /*!
+ * @class IWMWindowManager
+ * The core window manager class
+ */
@interface IWMWindowManager : NSObject
{
***************
*** 154,158 ****
- (Window *)clientWindowList;
! /*
* @method availableIconCoordinates
* @abstract Returns the first available coordinates for icons
--- 158,162 ----
- (Window *)clientWindowList;
! /*!
* @method availableIconCoordinates
* @abstract Returns the first available coordinates for icons
***************
*** 161,165 ****
--- 165,178 ----
- (NSRect)availableIconCoordinates;
+ /*!
+ * @method clientNames
+ * @discussion Returns an NSArray of all client names
+ */
- (NSArray *)clientNames;
+
+ /*!
+ * @method longestClientName
+ * @discussion Returns the longest name of all current clients
+ */
- (NSString *)longestClientName;
***************
*** 168,175 ****
--- 181,209 ----
*==========================================================================*/
+ /*!
+ * @method applyOverridesToWindowManager
+ * @discussion Applies defaults settings to the window manager
+ */
- (void)applyOverridesToWindowManager;
+
+ /*!
+ * @method applyOverridesToTheme:
+ * @discussion Applies defaults settings to the provided theme
+ * @param aTheme An IWMTheme
+ */
- (void)applyOverridesToTheme:(IWMTheme *)aTheme;
+ /*!
+ * @method loadThemeAtPath:
+ * @discussion Loads the IWMTheme specified by the provided path
+ * @param path A fully qualified path
+ */
- (BOOL)loadThemeAtPath:(NSString *)path;
+
+ /*!
+ * @method loadThemeNamed:
+ * @discussion Searches for and loads the theme with the provided name
+ * @param themeName An IWMTheme name
+ */
- (BOOL)loadThemeNamed:(NSString *)themeName;
***************
*** 198,202 ****
--- 232,248 ----
- (void)saveDefaults;
+ /*!
+ * @method addClient:
+ * @discussion Adds the provided client to the internal array of managed clients
+ * @param aClient An IWMClient
+ */
- (void)addClient:(IWMClient *)aClient;
+
+ /*!
+ * @method removeClient:
+ * @discussion Closes the provided client and removes it from the array of managed
+ * clients
+ * @param aClient An IWMClient
+ */
- (void)removeClient:(IWMClient *)aClient;
***************
*** 209,217 ****
--- 255,285 ----
- (void)setButton3:(id)aCommand;
+ /*!
+ * @method setOpaqueMovement:
+ * @discussion Sets whether or not clients should be moved opaquely (default:
+ * <b>NO</b>)
+ * @param opaque
+ */
- (void)setOpaqueMovement:(BOOL)opaque;
+ /*!
+ * @method headClient
+ * @discussion Returns the head client
+ */
- (IWMClient *)headClient;
+
+ /*!
+ * @method setHeadClient:
+ * @discussion Sets the provided client as the head client
+ * @param aClient An IWMClient
+ */
- (void)setHeadClient:(IWMClient *)aClient;
+
+ /*!
+ * @method cycleClients
+ * @discussion Cycles the clients on the screen
+ */
- (void)cycleClients;
+
- (void)clientIsClosing:(IWMClient *)aClient;
***************
*** 220,223 ****
--- 288,295 ----
*==========================================================================*/
+ /*!
+ * @method mousePosition
+ * @discussion Returns the current position of the cursor
+ */
- (XPoint)mousePosition;
- (IWMScreen *)currentScreen;
|