[wxWidgets.git] / interface / wx / dateevt.h

/////////////////////////////////////////////////////////////////////////////
// Name:        dateevt.h
// Purpose:     interface of wxDateEvent
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxDateEvent

    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() const;

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