Altium C++ SDK 3.0
Loading...
Searching...
No Matches
DXP.Param.h
Go to the documentation of this file.
1#pragma once
2
3#ifndef DXP_PARAM_H_INCLUDED
4#define DXP_PARAM_H_INCLUDED
5
6#include <string>
7#include <vector>
8
9/*..................................................................................................*/
11{
12private:
13 std::wstring mName;
14 std::wstring mValue;
15
16public:
17 std::wstring GetName ();
18 std::wstring GetValue();
19 void SetName (std::wstring AValue);
20 void SetValue(std::wstring AValue);
21
22 CParameter(std::wstring AName, std::wstring AValue, bool NeedTrimName = true);
23};
24/*..................................................................................................*/
25
26/*..................................................................................................*/
28{
29private:
30 std::vector<CParameter *> mParameters;
31
32public:
34
35 std::wstring GetState();
36 void SetState(std::wstring S);
37
38 std::wstring GetState_ToString();
39 void SetState_FromString(std::wstring S);
40
41 CParameter * GetState_ParameterByName(std::wstring AName);
42 bool SetState_RemoveByName (std::wstring AName);
43
44 void SetState_AddParameter (std::wstring AName, std::wstring AValue);
45 void SetState_AddParameterAsString (std::wstring AName, std::wstring AValue);
46 void SetState_AddParameterAsBoolean (std::wstring AName, bool AValue);
47 void SetState_AddParameterAsInteger (std::wstring AName, int AValue);
48 void SetState_AddParameterAsInt64 (std::wstring AName, INT64 AValue);
49 void SetState_AddParameterAsDouble (std::wstring AName, double AValue);
50
51 bool GetState_ParameterAsString (std::wstring AName, std::wstring * Value);
52 bool GetState_ParameterAsPChar (std::wstring AName, WCHAR * * Value);
53 bool GetState_ParameterAsLongInt (std::wstring AName, long * Value);
54 bool GetState_ParameterAsInteger (std::wstring AName, int * Value);
55 bool GetState_ParameterAsInt64 (std::wstring AName, INT64 * Value);
56 bool GetState_ParameterAsSmallInt (std::wstring AName, short * Value);
57 bool GetState_ParameterAsWord (std::wstring AName, WORD * Value);
58 bool GetState_ParameterAsByte (std::wstring AName, BYTE * Value);
59 bool GetState_ParameterAsBoolean (std::wstring AName, bool * Value);
60 bool GetState_ParameterAsWordBool (std::wstring AName, VARIANT_BOOL * Value);
61 bool GetState_ParameterAsReal (std::wstring AName, float * Value);
62 bool GetState_ParameterAsDouble (std::wstring AName, double * Value);
64};
65/*..................................................................................................*/
66
67/*..................................................................................................*/
68bool GetState_Parameter (std::wstring S, std::wstring Name, std::wstring * Value);
69void SetState_Parameter (std::wstring * S, std::wstring Name, std::wstring Value);
70void SetState_RemoveParameter(std::wstring * S, std::wstring Name);
71/*..................................................................................................*/
72
73/*..................................................................................................*/
74const std::wstring cGetStateParameter (L"GetActionState");
75const std::wstring cGetStateCaption (L"Caption");
76const std::wstring cGetStateBitmap (L"Bitmap");
77const std::wstring cGetStateEnabled (L"Enabled");
78const std::wstring cGetStateChecked (L"Checked");
79/*..................................................................................................*/
80
81/*..................................................................................................*/
82const std::wstring cValueParam (L"_Value_");
83const std::wstring cEditParam (L"_Edit_");
84const std::wstring cListParam (L"_ListItems_");
85const std::wstring cGetListParam (L"_GetList_");
86const std::wstring cModeParam (L"Mode");
87const std::wstring cPathParam (L"_Path_");
88const std::wstring cGetCountParam (L"_GetCount_");
89const std::wstring cGetItemParam (L"_GetItem_");
90
91const std::wstring cParamDelimiter (L"|");
92const std::wstring cParamDelim2 (L"" + (WCHAR)0x0002);
93const std::wstring CValuesDelimiter(L"~");
94/*..................................................................................................*/
95
96/*..................................................................................................*/
97std::wstring EncodeParameterString(const std::wstring & S);
98std::wstring DecodeParameterString(const std::wstring & S);
99/*..................................................................................................*/
100
101#endif // DXP_PARAM_H_INCLUDED
const std::wstring cGetCountParam(L"_GetCount_")
const std::wstring cParamDelim2(L""+(WCHAR) 0x0002)
std::wstring DecodeParameterString(const std::wstring &S)
const std::wstring CValuesDelimiter(L"~")
const std::wstring cValueParam(L"_Value_")
std::wstring EncodeParameterString(const std::wstring &S)
void SetState_RemoveParameter(std::wstring *S, std::wstring Name)
const std::wstring cGetStateEnabled(L"Enabled")
const std::wstring cListParam(L"_ListItems_")
const std::wstring cGetStateCaption(L"Caption")
const std::wstring cGetStateChecked(L"Checked")
const std::wstring cPathParam(L"_Path_")
const std::wstring cGetStateParameter(L"GetActionState")
const std::wstring cGetListParam(L"_GetList_")
bool GetState_Parameter(std::wstring S, std::wstring Name, std::wstring *Value)
const std::wstring cParamDelimiter(L"|")
const std::wstring cModeParam(L"Mode")
const std::wstring cEditParam(L"_Edit_")
void SetState_Parameter(std::wstring *S, std::wstring Name, std::wstring Value)
const std::wstring cGetStateBitmap(L"Bitmap")
const std::wstring cGetItemParam(L"_GetItem_")
Definition DXP.Param.h:11
std::wstring GetValue()
std::wstring mName
Definition DXP.Param.h:13
void SetName(std::wstring AValue)
std::wstring mValue
Definition DXP.Param.h:14
void SetValue(std::wstring AValue)
CParameter(std::wstring AName, std::wstring AValue, bool NeedTrimName=true)
std::wstring GetName()
Definition DXP.Param.h:28
bool GetState_ParameterAsInt64(std::wstring AName, INT64 *Value)
bool GetState_ParameterAsPChar(std::wstring AName, WCHAR **Value)
std::vector< CParameter * > mParameters
Definition DXP.Param.h:30
bool SetState_RemoveByName(std::wstring AName)
void ClearAllParameters()
void SetState_AddParameter(std::wstring AName, std::wstring AValue)
bool GetState_ParameterAsWordBool(std::wstring AName, VARIANT_BOOL *Value)
void SetState_AddParameterAsBoolean(std::wstring AName, bool AValue)
std::wstring GetState_ToString()
void SetState_AddParameterAsInt64(std::wstring AName, INT64 AValue)
bool GetState_ParameterAsInteger(std::wstring AName, int *Value)
bool GetState_ParameterAsDouble(std::wstring AName, double *Value)
void SetState(std::wstring S)
bool GetState_ParameterAsString(std::wstring AName, std::wstring *Value)
void SetState_AddParameterAsDouble(std::wstring AName, double AValue)
bool GetState_ParameterAsLongInt(std::wstring AName, long *Value)
bool GetState_ParameterAsBoolean(std::wstring AName, bool *Value)
CParameter * GetState_ParameterByName(std::wstring AName)
bool GetState_ParameterAsSmallInt(std::wstring AName, short *Value)
void SetState_FromString(std::wstring S)
bool GetState_ParameterAsWord(std::wstring AName, WORD *Value)
bool GetState_ParameterAsByte(std::wstring AName, BYTE *Value)
bool GetState_ParameterAsReal(std::wstring AName, float *Value)
void SetState_AddParameterAsString(std::wstring AName, std::wstring AValue)
std::wstring GetState()
void SetState_AddParameterAsInteger(std::wstring AName, int AValue)