684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
112 lines
3.6 KiB
C++
112 lines
3.6 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
|
|
Copyright (C) 1997 to 2002 Cristian Tibirna <tibirna@kde.org>
|
|
Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************/
|
|
|
|
#ifndef KWIN_PLACEMENT_H
|
|
#define KWIN_PLACEMENT_H
|
|
// KWin
|
|
#include <kwinglobals.h>
|
|
// Qt
|
|
#include <QPoint>
|
|
#include <QRect>
|
|
#include <QList>
|
|
|
|
class QObject;
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class AbstractClient;
|
|
class Client;
|
|
|
|
class KWIN_EXPORT Placement
|
|
{
|
|
public:
|
|
virtual ~Placement();
|
|
|
|
/**
|
|
* Placement policies. How workspace decides the way windows get positioned
|
|
* on the screen. The better the policy, the heavier the resource use.
|
|
* Normally you don't have to worry. What the WM adds to the startup time
|
|
* is nil compared to the creation of the window itself in the memory
|
|
*/
|
|
enum Policy {
|
|
NoPlacement, // not really a placement
|
|
Default, // special, means to use the global default
|
|
Unknown, // special, means the function should use its default
|
|
Random,
|
|
Smart,
|
|
Cascade,
|
|
Centered,
|
|
ZeroCornered,
|
|
UnderMouse, // special
|
|
OnMainWindow, // special
|
|
Maximizing
|
|
};
|
|
|
|
void place(AbstractClient* c, QRect& area);
|
|
|
|
void placeAtRandom(AbstractClient* c, const QRect& area, Policy next = Unknown);
|
|
void placeCascaded(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeSmart(AbstractClient* c, const QRect& area, Policy next = Unknown);
|
|
void placeMaximizing(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeCentered(AbstractClient* c, const QRect& area, Policy next = Unknown);
|
|
void placeZeroCornered(AbstractClient* c, const QRect& area, Policy next = Unknown);
|
|
void placeDialog(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeUtility(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeOnScreenDisplay(AbstractClient* c, QRect& area);
|
|
|
|
void reinitCascading(int desktop);
|
|
|
|
/**
|
|
* Cascades all clients on the current desktop
|
|
*/
|
|
void cascadeDesktop();
|
|
/**
|
|
* Unclutters the current desktop by smart-placing all clients again.
|
|
*/
|
|
void unclutterDesktop();
|
|
|
|
static Policy policyFromString(const QString& policy, bool no_special);
|
|
static const char* policyToString(Policy policy);
|
|
|
|
private:
|
|
void place(AbstractClient* c, QRect& area, Policy policy, Policy nextPlacement = Unknown);
|
|
void placeUnderMouse(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeOnMainWindow(AbstractClient* c, QRect& area, Policy next = Unknown);
|
|
void placeTransient(AbstractClient *c);
|
|
QRect checkArea(const AbstractClient*c, const QRect& area);
|
|
|
|
//CT needed for cascading+
|
|
struct DesktopCascadingInfo {
|
|
QPoint pos;
|
|
int col;
|
|
int row;
|
|
};
|
|
|
|
QList<DesktopCascadingInfo> cci;
|
|
|
|
KWIN_SINGLETON(Placement)
|
|
};
|
|
|
|
} // namespace
|
|
|
|
#endif
|