dismissablemessagecontext.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.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 3 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 LIBREPCB_EDITOR_DISMISSABLEMESSAGECONTEXT_H
#define LIBREPCB_EDITOR_DISMISSABLEMESSAGECONTEXT_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "appwindow.h"
 
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class Workspace;
 
namespace editor {
 
/*******************************************************************************
 *  Class DismissableMessageContext
 ******************************************************************************/
 
class DismissableMessageContext final : public QObject {
  Q_OBJECT
 
public:
  explicit DismissableMessageContext(bool active = false,
                                     QObject* parent = nullptr) noexcept;
 
  explicit DismissableMessageContext(Workspace& workspace,
                                     const QString& dismissKey,
                                     bool active = false,
                                     QObject* parent = nullptr) noexcept;
  DismissableMessageContext(const DismissableMessageContext& other) = delete;
  ~DismissableMessageContext() noexcept;
 
  ui::DismissableMessageData getUiData() const noexcept;
 
  void setUiData(const ui::DismissableMessageData& data) noexcept;
 
  void setActive(bool active) noexcept;
 
  void dismiss() noexcept;
 
  void dontShowAgain() noexcept;
 
  bool isVisible() const noexcept { return mVisible; }
 
  // Operator Overloadings
  DismissableMessageContext& operator=(const DismissableMessageContext& rhs) =
      delete;
 
signals:
  void visibilityChanged(bool visible);
 
private:  // Methods
  void trigger(ui::DismissableMessageAction a) noexcept;
  void dismissedMessagesModified() noexcept;
  void updateVisibility() noexcept;
 
private:  // Data
  const QPointer<Workspace> mWorkspace;
  const QString mDismissKey;
  bool mActive;
  bool mTemporarilyHidden;
  bool mVisible;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif