summaryrefslogtreecommitdiff
path: root/include/compplugin.h
blob: 0e2d0c963cf5495d7015fb6c3769714899679ef7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
 * Copyright © 2007 Novell, Inc.
 *
 * Permission to use, copy, modify, distribute, and sell this software
 * and its documentation for any purpose is hereby granted without
 * fee, provided that the above copyright notice appear in all copies
 * and that both that copyright notice and this permission notice
 * appear in supporting documentation, and that the name of
 * Novell, Inc. not be used in advertising or publicity pertaining to
 * distribution of the software without specific, written prior permission.
 * Novell, Inc. makes no representations about the suitability of this
 * software for any purpose. It is provided "as is" without express or
 * implied warranty.
 *
 * NOVELL, INC. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
 * NO EVENT SHALL NOVELL, INC. BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * Author: David Reveman <davidr@novell.com>
 */

#ifndef _COMPIZ_PLUGIN_H
#define _COMPIZ_PLUGIN_H

#include <compiz.h>
#include <compoption.h>

typedef bool (*InitPluginObjectProc) (CompObject *object);
typedef void (*FiniPluginObjectProc) (CompObject *object);

typedef CompOption::Vector & (*GetPluginObjectOptionsProc) (CompObject *object);
typedef bool (*SetPluginObjectOptionProc) (CompObject        *object,
					   const char        *name,
					   CompOption::Value &value);

class CompPluginVTable {

    public:
	virtual ~CompPluginVTable ();
	
	virtual const char * name () = 0;

	virtual CompMetadata *
	getMetadata ();

	virtual bool
	init () = 0;

	virtual void
	fini () = 0;

	virtual bool
	initObject (CompObject *object);

	virtual void
	finiObject (CompObject *object);
	
	virtual CompOption::Vector &
	getObjectOptions (CompObject *object);

	virtual bool
	setObjectOption (CompObject        *object,
			 const char        *name,
			 CompOption::Value &value);
};

COMPIZ_BEGIN_DECLS

CompPluginVTable *
getCompPluginInfo20080805 (void);

COMPIZ_END_DECLS

#endif