Merge remote-tracking branch 'fork/work/zakharafoniam/useful-groups'

[dolphin.git] / src / selectionmode / actionwithwidget.h

diff --git a/src/selectionmode/actionwithwidget.h b/src/selectionmode/actionwithwidget.h
index cf7b8bc35151eab2d25d5cf8cfa3385e12cd5f10..e56729a6fd7293360e985bcbabb53d9cf759c5b7 100644 (file)
--- a/src/selectionmode/actionwithwidget.h
+++ b/src/selectionmode/actionwithwidget.h
@@ -1,6 +1,6 @@
 /*
     This file is part of the KDE project
 /*
     This file is part of the KDE project

-    SPDX-FileCopyrightText: 2022 Felix Ernst <felixernst@zohomail.eu>
+    SPDX-FileCopyrightText: 2022 Felix Ernst <felixernst@kde.org>

 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */


@@ -21,6 +21,9 @@ namespace SelectionMode
  * @brief Small wrapper/helper class that contains an action and its widget.
  *
  * This class takes neither the responsibility for deleting its action() nor its widget().
  * @brief Small wrapper/helper class that contains an action and its widget.
  *
  * This class takes neither the responsibility for deleting its action() nor its widget().

+ *
+ * This class is only used from BottomBarContentsContainer currently.
+ * @see BottomBarContentsContainer

  */
 class ActionWithWidget
 {
  */
 class ActionWithWidget
 {


@@ -28,9 +31,9 @@ public:
     ActionWithWidget(QAction *action);
 
     /**
     ActionWithWidget(QAction *action);
 
     /**

-     * Connect @p action and @p button using copyActionDataToButton() and the
-     * wraps the two together in the ActionWithWidget object.
-     * ActionWithWidget doesn't take any ownership.
+     * Connect @p action and @p button using copyActionDataToButton() and
+     * wraps the two together in a ActionWithWidget object.
+     * ActionWithWidget doesn't take any ownership over the parameters.

      *
      * @see copyActionDataToButton()
      *
      *
      * @see copyActionDataToButton()
      *


@@ -38,14 +41,16 @@ public:
      */
     ActionWithWidget(QAction *action, QAbstractButton *button);
 
      */
     ActionWithWidget(QAction *action, QAbstractButton *button);
 

-    /** @returns the action of this object. Crashes if that action has been deleted elsewhere in the meantime. */
-    inline QAction *action() {
+    /** @returns the action of this object. */
+    inline QAction *action()
+    {

         Q_CHECK_PTR(m_action);
         return m_action;
     };
 
     /** @returns the widget of this object. */
         Q_CHECK_PTR(m_action);
         return m_action;
     };
 
     /** @returns the widget of this object. */

-    inline QWidget *widget() {
+    inline QWidget *widget()
+    {

         return m_widget;
     }
 
         return m_widget;
     }
 


@@ -58,7 +63,8 @@ public:
     QWidget *newWidget(QWidget *parent);
 
     /** returns true if the widget exists and is visible. false otherwise. */
     QWidget *newWidget(QWidget *parent);
 
     /** returns true if the widget exists and is visible. false otherwise. */

-    inline bool isWidgetVisible() const {
+    inline bool isWidgetVisible() const
+    {

         return m_widget && m_widget->isVisible();
     };
 
         return m_widget && m_widget->isVisible();
     };
 


@@ -69,7 +75,7 @@ private:
 
 /**
  * A small helper method.
 
 /**
  * A small helper method.

- * @return a button with the correct styling for the general mode of the SelectionModeBottomBar which can be added to its layout.
+ * @return a button with the correct styling for the general mode of the BottomBarContentsContainer which can be added to its layout.

  */
 QAbstractButton *newButtonForAction(QAction *action, QWidget *parent);
 
  */
 QAbstractButton *newButtonForAction(QAction *action, QWidget *parent);