/*
 * CDE - Common Desktop Environment
 *
 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
 *
 * These libraries and programs are free software; you can
 * redistribute them and/or modify them under the terms of the GNU
 * Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * These libraries and programs are distributed in the hope that
 * they will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with these libraries and programs; if not, write
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301 USA
 */
/* 
 * (c) Copyright 1989 Sun Microsystems, Inc.
 * (c) Copyright 1993 HEWLETT-PACKARD COMPANY 
 * ALL RIGHTS RESERVED 
 */ 

#ifndef _WM_OL_H
#define _WM_OL_H

/*
 * Property Names 
 */
#define OL_WIN_ATTR		"_OL_WIN_ATTR"
#define OL_DECOR_ADD		"_OL_DECOR_ADD"
#define OL_DECOR_DEL		"_OL_DECOR_DEL"

/*
 * Decoration atoms
 */
#define OL_DECOR_RESIZE		"_OL_DECOR_RESIZE"
#define OL_DECOR_FOOTER		"_OL_DECOR_FOOTER"
#define OL_DECOR_HEADER		"_OL_DECOR_HEADER"
#define OL_DECOR_PIN		"_OL_DECOR_PIN"
#define OL_DECOR_CLOSE		"_OL_DECOR_CLOSE"
#define OL_DECOR_ICON_NAME	"_OL_DECOR_ICON_NAME"
#define OL_PIN_IN		"_OL_PIN_IN"
#define OL_PIN_OUT		"_OL_PIN_OUT"

/*
 * Window types
 */
#define OL_WT_BASE		"_OL_WT_BASE"
#define OL_WT_CMD		"_OL_WT_CMD"
#define OL_WT_NOTICE		"_OL_WT_NOTICE"
#define OL_WT_HELP		"_OL_WT_HELP"
#define OL_WT_OTHER		"_OL_WT_OTHER"

/*
 * Menu Types
 */
#define OL_MENU_LIMITED		"_OL_MENU_LIMITED"
#define OL_MENU_FULL		"_OL_MENU_FULL"

/*
 * Structure of Open Look window attribute property
 */
typedef struct _OLWinAttr {
    unsigned long	flags;
    Atom		win_type;
    Atom		menu_type;
    unsigned long	pin_initial_state;
    unsigned long	cancel;
} OLWinAttr;
#define OLWINATTRLENGTH (sizeof(OLWinAttr)/sizeof(unsigned long))

typedef struct _old_OLWinAttr {
    Atom		win_type;
    Atom		menu_type;
    unsigned long	pin_initial_state;
} old_OLWinAttr;
#define OLDOLWINATTRLENGTH (sizeof(old_OLWinAttr)/sizeof(unsigned long))

/* pin states */
#define PIN_OUT		0
#define PIN_IN		1

/*
 * Values for flags in OLWinAttr
 */
#define WA_WINTYPE      (1<<0)
#define WA_MENUTYPE     (1<<1)
#define WA_PINSTATE     (1<<2)
#define WA_CANCEL       (1<<3)

#define ENTIRE_CONTENTS         (10000000L)

/*
 * Bit Flags for OL Window Decoration
 */
#define OLDecorHeader		(1L<<0)
#define OLDecorFooter		(1L<<1)
#define OLDecorPushPin		(1L<<2)
#define OLDecorCloseButton	(1L<<3)
#define OLDecorResizable	(1L<<4)
#define OLDecorIconName		(1L<<5)
#define OLDecorWarpToPin	(1L<<6)

/*
 * Public Functions
 */
extern Boolean HasOpenLookHints( ClientData *pCD );
extern OLWinAttr * GetOLWinAttr( ClientData *pCD );
extern Boolean GetOLDecorFlags(ClientData *pCD, Atom property,
	unsigned long *pDecor);
extern void InitOLCompat(void);
extern void ProcessOLDecoration(ClientData *pCD);



/*
 * Macros (public pseudo-functions)
 */
#define GetOLDecorAdd(pcd,ptr) (GetOLDecorFlags(pcd,wmGD.xa_OL_DECOR_ADD,ptr))
#define GetOLDecorDel(pcd,ptr) (GetOLDecorFlags(pcd,wmGD.xa_OL_DECOR_DEL,ptr))


/* Do not add anything after the following #endif */
#endif /* _WM_OL_H */