Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
add_watermark_action.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
27/**
28 * @brief A file Containing the AddWatermarkAction class.
29 *
30 * @file add_watermark_action.h
31 */
32
33#ifndef API_MIP_UPE_ADD_WATERMARK_ACTION_H_
34#define API_MIP_UPE_ADD_WATERMARK_ACTION_H_
35
36#include <string>
37
38#include "mip/common_types.h"
39#include "mip/mip_namespace.h"
40#include "mip/upe/action.h"
41
42MIP_NAMESPACE_BEGIN
43/**
44 * @brief An action class that specifies adding watermark.
45 */
46class AddWatermarkAction : public Action {
47public:
48 /**
49 * @brief An API used to mark the watermark element.
50 *
51 * @return the name that should be used for the UI element that holds the watermark.
52 * The same name will be returned in RemoveWatermarkingAction in case the watermark
53 * needs to be removed.
54 */
55 virtual const std::string& GetUIElementName() = 0;
56 /**
57 * @brief An API used to get the water mark layout.
58 *
59 * @return WatermarkLayout the watermarking layout in th form of an enum HORIZONTAL|DIAGONAL.
60 ,
61 */
62 virtual WatermarkLayout GetLayout() const = 0;
63 /**
64 * @brief Get the text that is meant to go into the watermark.
65 *
66 * @return content header text.
67 */
68 virtual const std::string& GetText() const = 0;
69 /**
70 * @brief Get the font name used to display the watermark.
71 *
72 * @return Font name. Default value is Calibri if nothing is set by the policy.
73 */
74 virtual const std::string& GetFontName() const = 0;
75 /**
76 * @brief Get the font size used to display the watermark.
77 *
78 * @return font size as an integer.
79 */
80 virtual int GetFontSize() const = 0;
81 /**
82 * @brief Get the font color used to display the watermark.
83 *
84 * @return font color as a string (for example, "#000000").
85 */
86 virtual const std::string& GetFontColor() const = 0;
87 /** @cond DOXYGEN_HIDE */
88 virtual ~AddWatermarkAction() {}
89
90protected:
91 AddWatermarkAction(const std::string& id) : Action(id) {}
92 /** @endcond */
93};
94
95MIP_NAMESPACE_END
96
97#endif // API_MIP_UPE_ADD_WATERMARK_ACTION_H_
A file containing the Action base class and the ActionType enumerator.
Interface for an action.
Definition action.h:93
An action class that specifies adding watermark.
virtual const std::string & GetFontName() const =0
Get the font name used to display the watermark.
virtual const std::string & GetText() const =0
Get the text that is meant to go into the watermark.
virtual const std::string & GetFontColor() const =0
Get the font color used to display the watermark.
virtual int GetFontSize() const =0
Get the font size used to display the watermark.
virtual const std::string & GetUIElementName()=0
An API used to mark the watermark element.
virtual WatermarkLayout GetLayout() const =0
An API used to get the water mark layout.
A file Containing the common types used by the upe, file and protection modules.
WatermarkLayout
Layout for watermarks.
MIP namespace macros.