Changeset View
Changeset View
Standalone View
Standalone View
focuschain.h
Show First 20 Lines • Show All 90 Lines • ▼ Show 20 Line(s) | 51 | public: | |||
---|---|---|---|---|---|
91 | /** | 91 | /** | ||
92 | * @brief Finds the best Client to become the new active Client in the focus chain for the given | 92 | * @brief Finds the best Client to become the new active Client in the focus chain for the given | ||
93 | * virtual @p desktop. | 93 | * virtual @p desktop. | ||
94 | * | 94 | * | ||
95 | * In case that separate screen focus is used only Clients on the current screen are considered. | 95 | * In case that separate screen focus is used only Clients on the current screen are considered. | ||
96 | * If no Client for activation is found @c null is returned. | 96 | * If no Client for activation is found @c null is returned. | ||
97 | * | 97 | * | ||
98 | * @param desktop The virtual desktop to look for a Client for activation | 98 | * @param desktop The virtual desktop to look for a Client for activation | ||
99 | * @return :Client* The Client which could be activated or @c null if there is none. | 99 | * @return :X11Client *The Client which could be activated or @c null if there is none. | ||
100 | */ | 100 | */ | ||
101 | AbstractClient *getForActivation(uint desktop) const; | 101 | AbstractClient *getForActivation(uint desktop) const; | ||
102 | /** | 102 | /** | ||
103 | * @brief Finds the best Client to become the new active Client in the focus chain for the given | 103 | * @brief Finds the best Client to become the new active Client in the focus chain for the given | ||
104 | * virtual @p desktop on the given @p screen. | 104 | * virtual @p desktop on the given @p screen. | ||
105 | * | 105 | * | ||
106 | * This method makes only sense to use if separate screen focus is used. If separate screen focus | 106 | * This method makes only sense to use if separate screen focus is used. If separate screen focus | ||
107 | * is disabled the @p screen is ignored. | 107 | * is disabled the @p screen is ignored. | ||
108 | * If no Client for activation is found @c null is returned. | 108 | * If no Client for activation is found @c null is returned. | ||
109 | * | 109 | * | ||
110 | * @param desktop The virtual desktop to look for a Client for activation | 110 | * @param desktop The virtual desktop to look for a Client for activation | ||
111 | * @param screen The screen to constrain the search on with separate screen focus | 111 | * @param screen The screen to constrain the search on with separate screen focus | ||
112 | * @return :Client* The Client which could be activated or @c null if there is none. | 112 | * @return :X11Client *The Client which could be activated or @c null if there is none. | ||
113 | */ | 113 | */ | ||
114 | AbstractClient *getForActivation(uint desktop, int screen) const; | 114 | AbstractClient *getForActivation(uint desktop, int screen) const; | ||
115 | 115 | | |||
116 | /** | 116 | /** | ||
117 | * @brief Checks whether the most recently used focus chain contains the given @p client. | 117 | * @brief Checks whether the most recently used focus chain contains the given @p client. | ||
118 | * | 118 | * | ||
119 | * Does not consider the per-desktop focus chains. | 119 | * Does not consider the per-desktop focus chains. | ||
120 | * @param client The Client to look for. | 120 | * @param client The Client to look for. | ||
Show All 16 Lines | |||||
137 | * | 137 | * | ||
138 | * The navigation wraps around the borders of the chain. That is if the @p reference Client is | 138 | * The navigation wraps around the borders of the chain. That is if the @p reference Client is | ||
139 | * the last item of the focus chain, the first Client will be returned. | 139 | * the last item of the focus chain, the first Client will be returned. | ||
140 | * | 140 | * | ||
141 | * If the @p reference Client cannot be found in the focus chain, the first element of the focus | 141 | * If the @p reference Client cannot be found in the focus chain, the first element of the focus | ||
142 | * chain is returned. | 142 | * chain is returned. | ||
143 | * | 143 | * | ||
144 | * @param reference The start point in the focus chain to search | 144 | * @param reference The start point in the focus chain to search | ||
145 | * @return :Client* The relatively next Client in the most recently used chain. | 145 | * @return :X11Client *The relatively next Client in the most recently used chain. | ||
146 | */ | 146 | */ | ||
147 | AbstractClient *nextMostRecentlyUsed(AbstractClient *reference) const; | 147 | AbstractClient *nextMostRecentlyUsed(AbstractClient *reference) const; | ||
148 | /** | 148 | /** | ||
149 | * @brief Queries the focus chain for @p desktop for the next Client in relation to the given | 149 | * @brief Queries the focus chain for @p desktop for the next Client in relation to the given | ||
150 | * @p reference Client. | 150 | * @p reference Client. | ||
151 | * | 151 | * | ||
152 | * The method finds the first usable Client which is not the @p reference Client. If no Client | 152 | * The method finds the first usable Client which is not the @p reference Client. If no Client | ||
153 | * can be found @c null is returned | 153 | * can be found @c null is returned | ||
154 | * | 154 | * | ||
155 | * @param reference The reference Client which should not be returned | 155 | * @param reference The reference Client which should not be returned | ||
156 | * @param desktop The virtual desktop whose focus chain should be used | 156 | * @param desktop The virtual desktop whose focus chain should be used | ||
157 | * @return :Client* The next usable Client or @c null if none can be found. | 157 | * @return :X11Client *The next usable Client or @c null if none can be found. | ||
158 | */ | 158 | */ | ||
159 | AbstractClient *nextForDesktop(AbstractClient *reference, uint desktop) const; | 159 | AbstractClient *nextForDesktop(AbstractClient *reference, uint desktop) const; | ||
160 | /** | 160 | /** | ||
161 | * @brief Returns the first Client in the most recently used focus chain. First Client in this | 161 | * @brief Returns the first Client in the most recently used focus chain. First Client in this | ||
162 | * case means really the first Client in the chain and not the most recently used Client. | 162 | * case means really the first Client in the chain and not the most recently used Client. | ||
163 | * | 163 | * | ||
164 | * @return :Client* The first Client in the most recently used chain. | 164 | * @return :X11Client *The first Client in the most recently used chain. | ||
165 | */ | 165 | */ | ||
166 | AbstractClient *firstMostRecentlyUsed() const; | 166 | AbstractClient *firstMostRecentlyUsed() const; | ||
167 | 167 | | |||
168 | public Q_SLOTS: | 168 | public Q_SLOTS: | ||
169 | /** | 169 | /** | ||
170 | * @brief Resizes the per virtual desktop focus chains from @p previousSize to @p newSize. | 170 | * @brief Resizes the per virtual desktop focus chains from @p previousSize to @p newSize. | ||
171 | * This means that for each virtual desktop between previous and new size a new focus chain is | 171 | * This means that for each virtual desktop between previous and new size a new focus chain is | ||
172 | * created and in case the number is reduced the focus chains are destroyed. | 172 | * created and in case the number is reduced the focus chains are destroyed. | ||
▲ Show 20 Lines • Show All 82 Lines • Show Last 20 Lines |