Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
label.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 */
33#ifndef API_MIP_UPE_LABEL_H_
34#define API_MIP_UPE_LABEL_H_
35
36#include <memory>
37#include <string>
38#include <vector>
39
40#include "mip/common_types.h"
41#include "mip/mip_export.h"
42#include "mip/mip_namespace.h"
43
44MIP_NAMESPACE_BEGIN
45
49class Label {
50public:
56 virtual const std::string& GetId() const = 0;
62 virtual const std::string& GetName() const = 0;
68 virtual const std::string& GetDescription() const = 0;
74 virtual const std::string& GetColor() const = 0;
80 virtual int GetSensitivity() const = 0;
86 virtual const std::string& GetTooltip() const = 0;
92 virtual const std::string& GetAutoTooltip() const = 0;
99 virtual bool IsActive() const = 0;
105 virtual std::weak_ptr<Label> GetParent() const = 0;
111 virtual const std::vector<std::shared_ptr<Label>>& GetChildren() const = 0;
117 virtual const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const = 0;
123 virtual ActionSource GetActionSource() const = 0;
129 virtual const std::vector<std::string>& GetContentFormats() const = 0;
137 virtual std::string GetDoubleKeyUrl() const = 0;
139 virtual ~Label() {}
140
141protected:
142 Label() {}
144};
145
146MIP_NAMESPACE_END
147
148#endif // API_MIP_UPE_LABEL_H_
Abstraction for a single Microsoft Information Protection label.
Definition label.h:49
virtual const std::vector< std::string > & GetContentFormats() const =0
Gets content types.
virtual const std::string & GetDescription() const =0
Get the label description.
virtual const std::vector< std::shared_ptr< Label > > & GetChildren() const =0
Get the children labels of the current label.
virtual const std::string & GetTooltip() const =0
Get the tooltip description of the label.
virtual std::string GetDoubleKeyUrl() const =0
Gets the double key URL, if the label requires double key user defined protection.
virtual ActionSource GetActionSource() const =0
Gets the action source of the label.
virtual const std::vector< std::pair< std::string, std::string > > & GetCustomSettings() const =0
Get the custom settings of a label.
virtual const std::string & GetAutoTooltip() const =0
Get the tooltip description of the classification that cause this label to be applied.
virtual const std::string & GetColor() const =0
Get the color the label should be displayed.
virtual const std::string & GetId() const =0
Get the label ID.
virtual std::weak_ptr< Label > GetParent() const =0
Get the parent label.
virtual int GetSensitivity() const =0
Get the Sensitivity of the label.
virtual bool IsActive() const =0
Gets a boolean signaling if the label is active.
virtual const std::string & GetName() const =0
Get the label name.
A file Containing the common types used by the upe, file and protection modules.
ActionSource
defines what triggered the SetLabel event
Definition common_types.h:84
A file export/import macros.
MIP namespace macros.