CMapPin v1.10

Welcome to CMapPin, a freeware MFC classes to provide map pins useful in GIS applications. Here's a small sample of what the map pins look like when overlaid on a bitmap map:

Features

• Standard CWnd derived class which can be used just like any other MFC control classes (e.g. CStatic) which are derived from CWnd.
• Support for tooltips, drag / drop and context menus is built in.
• For further customization, you can derive a class from it
• The class is fully Unicode compliant and includes Unicode built options in the workspace file.

Usage

• To use the class in your code simply include mappin.cpp in your project and #include mappin.h in which ever of your modules needs to make calls to the class.
• Attach an icon to the map pin using SetIcon and then call Create to actually create the map pin. That's it. You should now see the map pin  on your window.
• You should also have a look at the demo program to see exact details of how to use the map pins.

Copyright

• You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise) when your product is released in binary form.
• You are allowed to modify the source code in any way you want except you cannot modify the copyright details at the top of each module.
• If you want to distribute source code with your application, then you are only allowed to distribute versions released by the author. This is to maintain a single distribution point for the source code.

History

v1.10 (16 April 2022)

• Updated copyright details.
• Updated the code to use C++ uniform initialization for all variable declarations

v1.09 (9 May 2020)

• Fixed more Clang-Tidy static code analysis warnings in the code.

v1.08 (28 March 2020)

• Updated copyright details.
• Fixed more Clang-Tidy static code analysis warnings in the code.

v1.07 (3 June 2019)

• Updated copyright details.
• Updated the code to clean compile on VC 2019

v1.06 (30 December 2018)

• Updated copyright details.
• Fixed a number of C++ core guidelines compiler warnings. These changes mean that the code will now only compile on VC 2017 or later.

v1.05 (31 December 2016)

• Updated copyright details.
• Updated the sample apps main icon
• Replaced all occurrences of NULL with nullptr throughout the codebase
• Updated the code to clean compile on VC 2010 to VC 2015. The code now requires VC 2010 at a minimum.
• Added SAL annotations to all the code

v1.04 (24 March 2001)

• Updated copyright information 
• Fixed a redraw problem in OnMouseMove & SetIcon.

v1.03 (1 August 2000)

• Updated the sample app so that the sample bitmap leinster.bmp is now included in the project as a resource instead of loading it from disk at runtime, which was causing problems when you built the Release version of it.
• Updated sample app's view to avoid flickering.
• Removed unnecessary toolbar items from the sample app

v1.02 (12 June 2000)

• Now WM_COMMAND mesages are correctly sent to the parent window when the mappin button is clicked.

v1.01 (12 September 1998)

• Fixed a small redraw glitch in SetIcon.

v1.0 (13 August 1998)

• Initial public release.

API Reference

The API consists of the the public member functions of the class CMapPin:

CMapPin
~CMapPin
Create
SetIcon
GetIcon
SetPopupMenu
SetAllowDrag
GetAllowDrag

CMapPin::CMapPin

CMapPin();

Remarks

Standard C++ constructor. Just initializes internal variables to a default value.

CMapPin::~CMapPin

~CMapPin();

Remarks

Standard C++ destructor. Internally it will free any resources used by this instance.

CMapPin::Create

BOOL Create(LPCTSTR pszTooltipText, DWORD dwStyle, const CPoint& p, CWnd* pParent, UINT nID);

Return Value

Nonzero if successful; otherwise 0.

Parameters

pszTooltipText Specifies the tooltip text to use for the control. If NULL, no text will be visible.

dwStyle Specifies the control's window style. Normally this will just be WS_CHILD and WS_VISIBLE.

p Specifies the position of the control. The size will be taken from the attached icon.

pParentWnd Specifies the controls parent window, usually your CView derived class. It must not be NULL.

nID Specifies the control's control ID.

Remarks

Construct a CMapPin object in three steps. First call the constructor, then SetIcon and then call Create, which creates the Windows control and attaches it to the CMapPin object.

Apply the following window styles to a map pin control:

• WS_CHILD Always
• WS_VISIBLE Usually
• WS_DISABLED Rarely

CMapPin::SetIcon

bool SetIcon(HINSTANCE hModule, LPCTSTR pszResourceID, int nCXIcon = GetSystemMetrics(SM_CXSMICON), int nCYIcon = GetSystemMetrics(SM_CYSMICON));
bool SetIcon(HINSTANCE hModule, UINT nResourceID, int nCXIcon= GetSystemMetrics(SM_CXSMICON), int nCYIcon = GetSystemMetrics(SM_CYSMICON));

Return Value

true if successful otherwise false.

Parameters

hModule Handle to an instance of the module whose executable file contains the icon to be loaded.

pszResourceID Pointer to a null-terminated string that contains the name of the icon resource to be loaded.

nResourceID The resource identifier of the icon resource to be loaded.

nCXIcon Specifies the width of the icon to use.

nCYIcon Specifies the height of the icon to use.

Remarks

Modifies the icon to be displayed on the map pin.

CMapPin::GetIcon

HICON GetIcon() const;

Return Value

Returns the handle of the icon currently being used by this map pin instance.

CMapPin::SetPopupMenu

void SetPopupMenu(LPCTSTR pszResourceID);
void SetPopupMenu(UINT nResourceID);

Parameters

pszResourceID Pointer to a null-terminated string that contains the name of the menu resource to be used.

nResourceID The resource identifier of the menu resource to be used.

Remarks

Sets which menu resource will be used in context menus for this map pin instance.

CMapPin::SetAllowDrag

void SetAllowDrag(bool bAllowDrag);

Parameters

bAllowDrag true if you want to allow the map pin be dragable, false will disallow dragging.

Remarks

Changes whether or not the map pin can be dragged around.

CMapPin::GetAllowDrag

bool GetAllowDrag() const;

Return Value

true if the instance allows dragging, otherwise false.

Contacting the Author

PJ Naughter
Email: pjna@naughter.com
Web: http://www.naughter.com
16 April 2022