[wxWidgets.git] / interface / dateevt.h

/////////////////////////////////////////////////////////////////////////////
// Name:        dateevt.h
// Purpose:     documentation for wxDateEvent class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxDateEvent
    @wxheader{dateevt.h}

    This event class holds information about a date change and is used together
    with wxDatePickerCtrl. It also serves as a base class
    for wxCalendarEvent.

    @library{wxadv}
    @category{events}
*/
class wxDateEvent : public wxCommandEvent
{
public:
    /**
        Returns the date.
    */
    const wxDateTime GetDate();

    /**
        Sets the date carried by the event, normally only used by the library
        internally.
    */
    void SetDate(const wxDateTime& date);
};
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: dateevt.h
	3	// Purpose: documentation for wxDateEvent class
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxDateEvent
	11	@wxheader{dateevt.h}
7c913512	12
23324ae1 FM	13	This event class holds information about a date change and is used together
	14	with wxDatePickerCtrl. It also serves as a base class
	15	for wxCalendarEvent.
7c913512	16
23324ae1 FM	17	@library{wxadv}
	18	@category{events}
	19	*/
	20	class wxDateEvent : public wxCommandEvent
	21	{
	22	public:
	23	/**
	24	Returns the date.
	25	*/
	26	const wxDateTime GetDate();
	27
	28	/**
	29	Sets the date carried by the event, normally only used by the library
	30	internally.
	31	*/
	32	void SetDate(const wxDateTime& date);
	33	};