ecimagekey.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 
10 #pragma once
11 #include <Bentley/WString.h>
12 #include <ECObjects/ECObjects.h>
13 
14 typedef struct mdlDesc MdlDesc;
15 typedef uint32_t RscType; /* Resource Type */
16 typedef int32_t RscId; /* Resource Id */
17 
19 
20 /*=================================================================================**/
23 
25 struct ECImageKey
26  {
28  enum ImageType
29  {
34  };
35 
36  private:
37  WString m_name;
38  ImageType m_type;
39  RscId m_iconId;
40  RscType m_iconType;
41  MdlDesc* m_mdlDesc;
42 
43  public:
48  :m_name(name), m_type(type), m_iconType(0), m_iconId(0)
49  {}
50 
55  ECImageKey (long iconId, uint32_t iconType, MdlDesc* mdlDesc)
56  :m_type(RscIcon), m_iconType(iconType), m_iconId(iconId), m_mdlDesc(mdlDesc)
57  {}
58 
60  ImageType GetImageType() const {return m_type;}
62  void SetImageType(ImageType type) {m_type = type;}
63 
65  WStringCR GetImageName() const {return m_name;}
67  void SetImageName (WStringCR name) {m_name = name;}
68 
70  RscId GetIconId () const {return m_iconId;}
72  void SetIconId (RscId iconId) {m_iconId = iconId;}
73 
75  RscType GetIconType() const {return m_iconType;}
77  void SetIconType (RscType type) {m_iconType = type;}
78 
80  MdlDesc* GetMdlDesc() const {return m_mdlDesc;}
82  void SetMdlDesc(MdlDesc* desc) {m_mdlDesc = desc;}
83  };
84 
86 
RscType GetIconType() const
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:75
struct Bentley::WString const & WStringCR
Definition: Bentley.h:239
Definition: ecimagekey.h:31
void SetIconId(RscId iconId)
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:72
! ECImageKey holds an image information that can be used to get an actual image using ! image service...
Definition: ecimagekey.h:25
int int32_t
Definition: Bentley.r.h:92
WStringCR GetImageName() const
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:65
uint32_t RscType
Definition: ecimagekey.h:15
ECImageKey(WStringCR name, ImageType type)
Constructor for generic icon.
Definition: ecimagekey.h:47
MdlDesc * GetMdlDesc() const
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:80
ImageType
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:28
void SetMdlDesc(MdlDesc *desc)
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:82
void SetImageName(WStringCR name)
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:67
#define END_BENTLEY_ECOBJECT_NAMESPACE
Definition: DgnPlatform.h:41
Definition: ecimagekey.h:32
ImageType GetImageType() const
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:60
void SetIconType(RscType type)
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:77
void SetImageType(ImageType type)
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:62
RscId GetIconId() const
NEEDSWORK: Add comment here.
Definition: ecimagekey.h:70
unsigned int uint32_t
Definition: Bentley.r.h:93
ECImageKey(long iconId, uint32_t iconType, MdlDesc *mdlDesc)
Constructor for rsc icon.
Definition: ecimagekey.h:55
struct mdlDesc MdlDesc
Definition: DgnTool.h:18
Definition: ecimagekey.h:33
int32_t RscId
Definition: ecimagekey.h:16
Definition: ecimagekey.h:30
A string class that has many of the same capabilities as std::string, plus additional functions such ...
Definition: WString.h:51
#define BEGIN_BENTLEY_ECOBJECT_NAMESPACE
Definition: DgnPlatform.h:40

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.