kwin/atoms.h
Vlad Zagorodniy 684b4b635e Use more traditional doxygen style
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
2019-07-29 22:06:19 +03:00

111 lines
3 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) 2003 Lubos Lunak <l.lunak@kde.org>
Copyright (C) 2013 Martin Gräßlin <mgraesslin@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_ATOMS_H
#define KWIN_ATOMS_H
#include "xcbutils.h"
namespace KWin
{
class KWIN_EXPORT Atoms
{
public:
Atoms();
Xcb::Atom kwin_running;
Xcb::Atom activities;
Xcb::Atom wm_protocols;
Xcb::Atom wm_delete_window;
Xcb::Atom wm_take_focus;
Xcb::Atom wm_change_state;
Xcb::Atom wm_client_leader;
Xcb::Atom wm_window_role;
Xcb::Atom wm_state;
Xcb::Atom sm_client_id;
Xcb::Atom motif_wm_hints;
Xcb::Atom net_wm_context_help;
Xcb::Atom net_wm_ping;
Xcb::Atom net_wm_user_time;
Xcb::Atom kde_net_wm_user_creation_time;
Xcb::Atom net_wm_take_activity;
Xcb::Atom net_wm_window_opacity;
Xcb::Atom xdnd_selection;
Xcb::Atom xdnd_aware;
Xcb::Atom xdnd_enter;
Xcb::Atom xdnd_type_list;
Xcb::Atom xdnd_position;
Xcb::Atom xdnd_status;
Xcb::Atom xdnd_action_copy;
Xcb::Atom xdnd_action_move;
Xcb::Atom xdnd_action_ask;
Xcb::Atom xdnd_drop;
Xcb::Atom xdnd_leave;
Xcb::Atom xdnd_finished;
Xcb::Atom net_frame_extents;
Xcb::Atom kde_net_wm_frame_strut;
Xcb::Atom net_wm_sync_request_counter;
Xcb::Atom net_wm_sync_request;
Xcb::Atom kde_net_wm_shadow;
Xcb::Atom kde_net_wm_tab_group;
Xcb::Atom kde_first_in_window_list;
Xcb::Atom kde_color_sheme;
Xcb::Atom kde_skip_close_animation;
Xcb::Atom kde_screen_edge_show;
Xcb::Atom gtk_frame_extents;
Xcb::Atom kwin_dbus_service;
Xcb::Atom utf8_string;
Xcb::Atom text;
Xcb::Atom uri_list;
Xcb::Atom netscape_url;
Xcb::Atom moz_url;
Xcb::Atom wl_surface_id;
Xcb::Atom kde_net_wm_appmenu_service_name;
Xcb::Atom kde_net_wm_appmenu_object_path;
Xcb::Atom clipboard;
Xcb::Atom timestamp;
Xcb::Atom targets;
Xcb::Atom delete_atom;
Xcb::Atom incr;
Xcb::Atom wl_selection;
/**
* @internal
*/
void retrieveHelpers();
private:
// helper atoms we need to resolve to "announce" support (see #172028)
Xcb::Atom m_dtSmWindowInfo;
Xcb::Atom m_motifSupport;
bool m_helpersRetrieved;
};
extern KWIN_EXPORT Atoms* atoms;
} // namespace
#endif