Differential D17013 Diff 46321 src/ktoggleshowmenubaraction.h

Changeset View

Standalone View

View Options

src/ktoggleshowmenubaraction.h

  • This file was added.
1​/* This file is part of the KDE libraries
2​ Copyright (C) 2018 Luca Sartorelli <dj3mb3@gmail.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License version 2 as published by the Free Software Foundation.
7​
8​ This library is distributed in the hope that it will be useful,
9​ but WITHOUT ANY WARRANTY; without even the implied warranty of
10​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11​ Library General Public License for more details.
12​
13​ You should have received a copy of the GNU Library General Public License
14​ along with this library; see the file COPYING.LIB. If not, write to
15​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
16​ Boston, MA 02110-1301, USA.
17​*/
18​
19​#ifndef KTOGGLESHOWMENUBARACTION_H
20​#define KTOGGLESHOWMENUBARACTION_H
21​
22​#include <ktoggleaction.h>
23​
24​/**
25​ * @class KToggleShowMenuBarAction KToggleShowMenuBarAction.h KToggleShowMenuBarAction
26​ *
27​ * An action to hide or show the menubar of a window.
28​ * The action by default remind the user how to show
29​ * the menu bar using the keyboard shortcut.
cfeckUnsubmitted
Done

reminds

Additionally, "show back" does not sound like proper english, but I am not a native english speaker.

cfeck: reminds Additionally, "show back" does not sound like proper english, but I am not a native…
lsartorelliAuthorUnsubmitted
Done

Unfortunately, me too, ... any suggestion is appreciated

lsartorelli: Unfortunately, me too, ... any suggestion is appreciated
30​ *
31​ * @author Luca Sartorelli <dj3mb3@gmail.com>
32​ */
33​class KWIDGETSADDONS_EXPORT KToggleShowMenuBarAction : public KToggleAction
34​{
35​ Q_OBJECT
36​
37​public:
38​ /**
39​ * Create a KToggleShowMenuBarAction. Call setWindow() to associate this
40​ * action with a parent window for the message box.
41​ *
42​ * @param parent This action's parent object.
43​ */
44​ explicit KToggleShowMenuBarAction(QObject *parent);
45​
46​ /**
47​ * Create a KToggleShowMenuBarAction
48​ * @param window the parent window to be associated to the message box.
49​ * @param parent This action's parent object.
50​ */
broulikUnsubmitted
Not Done

I know we typically use window here for legacy reasons, but given there's QWindow in Qt 5, might be better to use widget for all of this now?
Just asking, you don't have to change this now, unless someone else comments :)

broulik: I know we typically use `window` here for legacy reasons, but given there's `QWindow` in Qt 5…
51​ KToggleShowMenuBarAction(QWidget *window, QObject *parent);
52​
53​ /**
54​ * Destroys the toggle show menubar action.
55​ */
56​ ~KToggleShowMenuBarAction() override;
57​
58​ /**
ngrahamUnsubmitted
Done

remainder -> reminder

ngraham: remainder -> reminder
59​ * Sets the parent window for message box with the user reminder.
60​ * @param window the window that will be parent for the message box
61​ * @since 5.54
62​ */
63​ void setWindow(QWidget *window);
64​
65​ /**
ngrahamUnsubmitted
Done

show back the menu bar -> show the menu bar again

keyborad -> keyboard

ngraham: show back the menu bar -> show the menu bar again keyborad -> keyboard
66​ * If set to true, this action will remind the user through a message box
67​ * on how to show the menu bar again, using the keyboard shortcut.
68​ * Default: false
69​ * @param show the window that will switch to/from full screen mode
70​ * @since 5.54
71​ */
72​ void setShowMessage(bool show);
73​
74​ /**
75​ * @returns true if the user reminder needs to be shown.
76​ * @since 5.54
77​ */
78​ bool showMessage();
79​
broulikUnsubmitted
Done

There's an extra empty line

broulik: There's an extra empty line
80​protected Q_SLOTS:
81​ void slotToggled(bool checked) override;
82​
83​private:
84​ class Private;
85​ Private *const d;
86​};
87​
88​#endif