OnReportColumnOrderChanged documentation error!

Author

Message

Topic Search

Topic Options

mgampi

Senior Member

Joined: 14 July 2003
Status: Offline
Points: 1210

Post Options

Post Reply

Quote mgampi

Report Post

Thanks(0)

Quote

Topic: OnReportColumnOrderChanged documentation error!
Posted: 16 July 2009 at 8:26am

BEGIN_MESSAGE_MAP(CReportSampleView, CXTPReportView)
    ON_NOTIFY(XTP_NM_REPORT_COLUMNORDERCHANGED, XTP_ID_REPORT_CONTROL, OnReportColumnOrderChanged)
END_MESSAGE_MAP()

void CReportSampleView::OnReportColumnOrderChanged(NMHDR*  pNotifyStruct, LRESULT* /*result*/)
{
    XTP_NM_REPORTRECORDITEM* pItemNotify = (XTP_NM_REPORTRECORDITEM*) pNotifyStruct;
    ASSERT(pItemNotify != NULL);

    // TODO: Handle command.
}

should be changed to :

XTP_NM_REPORTCOLUMNORDERCHANGED

Martin

Product: Xtreme Toolkit v 22.1.0, new Projects v 24.0.0
Platform: Windows 10 v 22H2 (64bit)
Language: VC++ 2022

mdoubson

Senior Member

Joined: 17 November 2008
Status: Offline
Points: 1705

Post Options

Post Reply

Quote mdoubson

Report Post

Thanks(0)

Quote

Posted: 16 July 2009 at 3:47pm

Sure - this is why good to have fresh source!

mgampi

Senior Member

Joined: 14 July 2003
Status: Offline
Points: 1210

Post Options

Post Reply

Quote mgampi

Report Post

Thanks(0)

Quote

Posted: 16 July 2009 at 5:06pm

But in source it's documented in the same wrong way and I don't have the time to study tons of foreign source code. So I first consult documentation.

Martin

Product: Xtreme Toolkit v 22.1.0, new Projects v 24.0.0
Platform: Windows 10 v 22H2 (64bit)
Language: VC++ 2022

mdoubson

Senior Member

Joined: 17 November 2008
Status: Offline
Points: 1705

Post Options

Post Reply

Quote mdoubson

Report Post

Thanks(0)

Quote

Posted: 16 July 2009 at 5:14pm

Right - it was somebody old comment formaly good to make Doc-O-Matic happy. Thanks for your catch - I will change source comment right now:

//-----------------------------------------------------------------------

// Summary:

// Defines message for column changed event.

// Parameters:

// id - Resource ID for the control.

// memberFxn - Name of member function to handle the message.

// Remarks:

// The XTP_NM_REPORT_COLUMNORDERCHANGED notification message is sent to inform

// the owner window that the user change the order of columns of report control.

// The owner window of the report control receives this notification

// threw the WM_COMMAND message.

// Example:

// Here is an example of how an application would handle this message.

// <code>

// BEGIN_MESSAGE_MAP(CReportSampleView, CXTPReportView)

// ON_NOTIFY(XTP_NM_REPORT_COLUMNORDERCHANGED, XTP_ID_REPORT_CONTROL, OnReportColumnOrderChanged)

// END_MESSAGE_MAP()

// void CReportSampleView::OnReportColumnOrderChanged(NMHDR* pNotifyStruct, LRESULT* /*result*/)

// {

// XTP_NM_REPORTCOLUMNORDERCHANGED* pItemNotify = (XTP_NM_REPORTCOLUMNORDERCHANGED*) pNotifyStruct;

// ASSERT(pItemNotify != NULL);

// // TODO: Handle command.

// }

// </code>