diff options
author | saturneric <[email protected]> | 2023-11-06 09:17:47 +0000 |
---|---|---|
committer | saturneric <[email protected]> | 2023-11-06 09:17:47 +0000 |
commit | 0251f35c93e3f0e0a6853a50fb5bd82c1b9e4187 (patch) | |
tree | 0025299b6b6bb0be2c41e6798ae7b09d16b52773 /src/core/function/basic/ChannelObject.h | |
parent | feat: update thridparty libraries (diff) | |
download | GpgFrontend-0251f35c93e3f0e0a6853a50fb5bd82c1b9e4187.tar.gz GpgFrontend-0251f35c93e3f0e0a6853a50fb5bd82c1b9e4187.zip |
refactor: clean up core's codes
Diffstat (limited to 'src/core/function/basic/ChannelObject.h')
-rw-r--r-- | src/core/function/basic/ChannelObject.h | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/src/core/function/basic/ChannelObject.h b/src/core/function/basic/ChannelObject.h new file mode 100644 index 00000000..9d247e6a --- /dev/null +++ b/src/core/function/basic/ChannelObject.h @@ -0,0 +1,80 @@ +/** + * Copyright (C) 2021 Saturneric <[email protected]> + * + * This file is part of GpgFrontend. + * + * GpgFrontend 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. + * + * GpgFrontend 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 GpgFrontend. If not, see <https://www.gnu.org/licenses/>. + * + * The initial version of the source code is inherited from + * the gpg4usb project, which is under GPL-3.0-or-later. + * + * All the source code of GpgFrontend was modified and released by + * Saturneric <[email protected]> starting on May 12, 2021. + * + * SPDX-License-Identifier: GPL-3.0-or-later + * + */ + +#pragma once + +namespace GpgFrontend { + +static constexpr int kGpgFrontendDefaultChannel = + 0; ///< the default channel id + +/** + * @brief object which in channel system is called "channel" + * + */ +class GPGFRONTEND_CORE_EXPORT ChannelObject { + public: + /** + * @brief Construct a new Default Channel Object object + * + */ + ChannelObject() noexcept; + + /** + * @brief Construct a new Channel Object object + * + * @param channel + */ + explicit ChannelObject(int channel); + + /** + * @brief Get the Default Channel object + * + * @return int + */ + static auto GetDefaultChannel() -> int; + + /** + * @brief Get the Channel object + * + * @return int + */ + [[nodiscard]] auto GetChannel() const -> int; + + /** + * @brief Set the Channel object + * + * @param channel + */ + void SetChannel(int channel); + + private: + int channel_ = kGpgFrontendDefaultChannel; ///< The channel id +}; + +} // namespace GpgFrontend
\ No newline at end of file |