PMManagedWindow.h

/**
 * Étoilé ProjectManager - PMDecoratedWindow.h
 *
 * Copyright (C) 2009 David Chisnall
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 **/
#import <XCBKit/XCBWindow.h>
#import <XCBKit/ICCCM.h>

typedef enum _PMManagedWindowState
{
	/**
	  * The managed window is waiting on the child to move
	  * to the available state so that it can figure out
	  * mapping behaviour.
	  */
	PMManagedWindowPendingState,
	/**
	  * An "unknown" state, where the managed window is
	  * waiting for all the child properties to be cached
	  * before transitioning into the withdrawn/iconic/normal
	  * states
	  */
	PMManagedWindowWaitingOnPropertiesState,
	PMManagedWindowWithdrawnState,
	PMManagedWindowIconicState,
	PMManagedWindowNormalState
} PMManagedWindowState;

@protocol PMManagedWindowDecorator;
@protocol PMManagedWindowDelegate;

@interface PMManagedWindow : NSObject {
	id<PMManagedWindowDelegate> delegate;
	XCBWindow *child;
	XCBWindow *decorationWindow;
	PMManagedWindowState state;

	// The decoration strategy aka the "decorator"
	NSObject<PMManagedWindowDecorator> *decorator;

	// Pending events to be processed
	NSArray* pendingEvents;

	BOOL has_focus;

	// Fields used during map and unmap transitions
	NSMutableSet *pendingWindowProperties;
	BOOL ignoreUnmap;
	BOOL reparented;

	// Fields used during window moving and resizing
	XCBPoint mouseDownPosition;
	XCBRect mouseDownClientFrame;
	int moveresizeType;

	// Fields used during focus
	BOOL input_hint;
	BOOL wm_take_focus;

	// Other fields
	XCBPoint refPoint;
	icccm_wm_size_hints_t wm_size_hints;

	xcb_window_t window_group;
	int16_t req_border_width;

	// Shape caching
	BOOL shapedBounding, shapedClip;
}
- (id)initWithChildWindow: (XCBWindow*)win pendingEvents: (NSArray*)pending;
- (XCBWindow*)childWindow;
- (XCBWindow*)decorationWindow;
- (void)setDelegate: (id<PMManagedWindowDelegate>)delegate;

- (void)establishInactiveGrabs;
- (void)releaseInactiveGrabs;
/**
  * Gets the outermost window managed
  * by this object. It is the decoration
  * window when the object is decorated, and
  * the child window when there is
  * no decoration window
  */
- (XCBWindow*)outermostWindow;
- (BOOL)hasFocus;
@end

@protocol PMManagedWindowDelegate
@optional
- (void)managedWindowWithdrawn: (PMManagedWindow*)managedWindow;
- (void)managedWindowDestroyed: (PMManagedWindow*)managedWindow;
- (void)managedWindowDidMap: (PMManagedWindow*)managedWindow;

@required
- (NSArray*)managedWindowDecorators: (PMManagedWindow*)managedWindow;
@end