blob: 17670e26a5e0e6a7ab836fc703cbe28fc114d382 (
plain) (
blame)
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*
* Copyright (c) 2013 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*/
package org.eclipse.cdt.qt.core.index;
import java.util.Collection;
import java.util.List;
/**
* A class that inherits the Qt QObject and contains an expansion of Q_OBJECT. This
* provides a handle for retrieving signals, slots, and other Qt-related elements.
* @see IQMethod
*/
public interface IQObject extends IQElement {
/**
* The interface to be implemented by elements that can be returned as members of an
* implementation of {@link IQObject}.
*/
public static interface IMember {
/**
* Return the QObject class that declares this member. Does not return null.
*/
public IQObject getOwner();
/**
* Returns true if it is <strong>*possible*</strong> for this member and the parameter
* to override each the other. A true result indicates that <strong>*if*</strong> the members
* owner's are related by inheritance then one will override the other; the implementation
* does not check that there actually is such an inheritance relationship.
*/
public boolean isOverride(IMember member);
}
/**
* A wrapper for unmodifiable collections of members of a class. Accessors provide filtered
* views of the member list.
*
* @see #all()
* @see #locals()
* @see #withoutOverrides()
*/
public static interface IMembers<T extends IMember> {
/**
* Returns an unmodifiable collection with all locally declared, inherited, and overridden
* members. Does not return null.
*/
public Collection<T> all();
/**
* Returns an unmodifiable collection with only the members that are locally declared in the
* source class. Does not return null.
*/
public Collection<T> locals();
/**
* Returns an unmodifiable collection of all locally declared and inherited members with the
* overridden members filtered out. Does not return null.
*/
public Collection<T> withoutOverrides();
}
/**
* Returns the name of the class.
*/
public String getName();
/**
* Returns a list of the QObject's that are bases of this class.
* E.g. in:
* <pre>
* class T {};
* class B1 : public QObject { Q_OBJECT };
* class B2 : public QObject { Q_OBJECT };
* class B3 : public T, public QObject { };
* class D : public B1, public B2, public B3, public T { Q_OBJECT };
* </pre>
* The list of bases for D will contain B1 and B2, but not B3 or T.
* <p>
* The list will be ordered as in the C++ code and will include only the directly declared
* base classes.
*/
public List<IQObject> getBases();
/**
* Returns the expansions of the Q_PROPERTY macro. Does not return null.
*/
public IMembers<IQProperty> getProperties();
/**
* Examines the Q_CLASSINFO expansions to return the value associated with the given
* key. Returns null if there isn't a Q_CLASSINFO for the given key.
*/
public String getClassInfo(String key);
/**
* Returns an unsorted collection of all Q_ENUMS macro expansions within this QObject's class
* declaration.
* @see IQEnum
*/
public Collection<IQEnum> getEnums();
}
|
