[wxWidgets.git] / include / wx / calctrl.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/calctrl.h
// Purpose:     date-picker control
// Author:      Vadim Zeitlin
// Modified by:
// Created:     29.12.99
// RCS-ID:      $Id$
// Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_CALCTRL_H_
#define _WX_CALCTRL_H_

#include "wx/defs.h"

#if wxUSE_CALENDARCTRL

#include "wx/dateevt.h"
#include "wx/colour.h"
#include "wx/font.h"
#include "wx/control.h"

// ----------------------------------------------------------------------------
// wxCalendarCtrl flags
// ----------------------------------------------------------------------------

enum
{
    // show Sunday as the first day of the week (default)
    wxCAL_SUNDAY_FIRST               = 0x0000,

    // show Monday as the first day of the week
    wxCAL_MONDAY_FIRST               = 0x0001,

    // highlight holidays
    wxCAL_SHOW_HOLIDAYS              = 0x0002,

    // disable the year change control, show only the month change one
    // deprecated
    wxCAL_NO_YEAR_CHANGE             = 0x0004,

    // don't allow changing neither month nor year (implies
    // wxCAL_NO_YEAR_CHANGE)
    wxCAL_NO_MONTH_CHANGE            = 0x000c,

    // use MS-style month-selection instead of combo-spin combination
    wxCAL_SEQUENTIAL_MONTH_SELECTION = 0x0010,

    // show the neighbouring weeks in the previous and next month
    wxCAL_SHOW_SURROUNDING_WEEKS     = 0x0020,

    // show week numbers on the left side of the calendar.
    wxCAL_SHOW_WEEK_NUMBERS          = 0x0040
};

// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------

// return values for the HitTest() method
enum wxCalendarHitTestResult
{
    wxCAL_HITTEST_NOWHERE,      // outside of anything
    wxCAL_HITTEST_HEADER,       // on the header (weekdays)
    wxCAL_HITTEST_DAY,          // on a day in the calendar
    wxCAL_HITTEST_INCMONTH,
    wxCAL_HITTEST_DECMONTH,
    wxCAL_HITTEST_SURROUNDING_WEEK,
    wxCAL_HITTEST_WEEK
};

// border types for a date
enum wxCalendarDateBorder
{
    wxCAL_BORDER_NONE,          // no border (default)
    wxCAL_BORDER_SQUARE,        // a rectangular border
    wxCAL_BORDER_ROUND          // a round border
};

// ----------------------------------------------------------------------------
// wxCalendarDateAttr: custom attributes for a calendar date
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_ADV wxCalendarDateAttr
{
public:
    // ctors
    wxCalendarDateAttr(const wxColour& colText = wxNullColour,
                       const wxColour& colBack = wxNullColour,
                       const wxColour& colBorder = wxNullColour,
                       const wxFont& font = wxNullFont,
                       wxCalendarDateBorder border = wxCAL_BORDER_NONE)
        : m_colText(colText), m_colBack(colBack),
          m_colBorder(colBorder), m_font(font)
    {
        Init(border);
    }
    wxCalendarDateAttr(wxCalendarDateBorder border,
                       const wxColour& colBorder = wxNullColour)
        : m_colBorder(colBorder)
    {
        Init(border);
    }

    // setters
    void SetTextColour(const wxColour& colText) { m_colText = colText; }
    void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
    void SetBorderColour(const wxColour& col) { m_colBorder = col; }
    void SetFont(const wxFont& font) { m_font = font; }
    void SetBorder(wxCalendarDateBorder border) { m_border = border; }
    void SetHoliday(bool holiday) { m_holiday = holiday; }

    // accessors
    bool HasTextColour() const { return m_colText.Ok(); }
    bool HasBackgroundColour() const { return m_colBack.Ok(); }
    bool HasBorderColour() const { return m_colBorder.Ok(); }
    bool HasFont() const { return m_font.Ok(); }
    bool HasBorder() const { return m_border != wxCAL_BORDER_NONE; }

    bool IsHoliday() const { return m_holiday; }

    const wxColour& GetTextColour() const { return m_colText; }
    const wxColour& GetBackgroundColour() const { return m_colBack; }
    const wxColour& GetBorderColour() const { return m_colBorder; }
    const wxFont& GetFont() const { return m_font; }
    wxCalendarDateBorder GetBorder() const { return m_border; }

    // get or change the "mark" attribute, i.e. the one used for the items
    // marked with wxCalendarCtrl::Mark()
    static const wxCalendarDateAttr& GetMark() { return m_mark; }
    static void SetMark(wxCalendarDateAttr const& m) { m_mark = m; }

protected:
    void Init(wxCalendarDateBorder border = wxCAL_BORDER_NONE)
    {
        m_border = border;
        m_holiday = false;
    }

private:
    static wxCalendarDateAttr m_mark;

    wxColour m_colText,
             m_colBack,
             m_colBorder;
    wxFont   m_font;
    wxCalendarDateBorder m_border;
    bool m_holiday;
};

// ----------------------------------------------------------------------------
// wxCalendarCtrl events
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_FWD_ADV wxCalendarCtrl;

class WXDLLIMPEXP_ADV wxCalendarEvent : public wxDateEvent
{
public:
    wxCalendarEvent() : m_wday(wxDateTime::Inv_WeekDay)  { }
    wxCalendarEvent(wxWindow *win, const wxDateTime& dt, wxEventType type)
        : wxDateEvent(win, dt, type),
          m_wday(wxDateTime::Inv_WeekDay) { }
    wxCalendarEvent(const wxCalendarEvent& event)
        : wxDateEvent(event), m_wday(event.m_wday) { }

    void SetWeekDay(const wxDateTime::WeekDay wd) { m_wday = wd; }
    wxDateTime::WeekDay GetWeekDay() const { return m_wday; }

    virtual wxEvent *Clone() const { return new wxCalendarEvent(*this); }

private:
    wxDateTime::WeekDay m_wday;

    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCalendarEvent)
};

// ----------------------------------------------------------------------------
// wxCalendarCtrlBase
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_ADV wxCalendarCtrlBase : public wxControl
{
public:
    // do we allow changing the month/year?
    bool AllowMonthChange() const { return !HasFlag(wxCAL_NO_MONTH_CHANGE); }

    // get/set the current date
    virtual wxDateTime GetDate() const = 0;
    virtual bool SetDate(const wxDateTime& date) = 0;


    // restricting the dates shown by the control to the specified range: only
    // implemented in the generic and MSW versions for now

    // if either date is set, the corresponding limit will be enforced and true
    // returned; if none are set, the existing restrictions are removed and
    // false is returned
    virtual bool
    SetDateRange(const wxDateTime& WXUNUSED(lowerdate) = wxDefaultDateTime,
                 const wxDateTime& WXUNUSED(upperdate) = wxDefaultDateTime)
    {
        return false;
    }

    // retrieves the limits currently in use (wxDefaultDateTime if none) in the
    // provided pointers (which may be NULL) and returns true if there are any
    // limits or false if none
    virtual bool
    GetDateRange(wxDateTime *lowerdate, wxDateTime *upperdate) const
    {
        if ( lowerdate )
            *lowerdate = wxDefaultDateTime;
        if ( upperdate )
            *upperdate = wxDefaultDateTime;
        return false;
    }

    // returns one of wxCAL_HITTEST_XXX constants and fills either date or wd
    // with the corresponding value (none for NOWHERE, the date for DAY and wd
    // for HEADER)
    //
    // notice that this is not implemented in all versions
    virtual wxCalendarHitTestResult
    HitTest(const wxPoint& WXUNUSED(pos),
            wxDateTime* WXUNUSED(date) = NULL,
            wxDateTime::WeekDay* WXUNUSED(wd) = NULL)
    {
        return wxCAL_HITTEST_NOWHERE;
    }

    // allow or disable changing the current month (and year), return true if
    // the value of this option really changed or false if it was already set
    // to the required value
    //
    // NB: we provide implementation for this pure virtual function, derived
    //     classes should call it
    virtual bool EnableMonthChange(bool enable = true) = 0;


    // an item without custom attributes is drawn with the default colours and
    // font and without border, setting custom attributes allows to modify this
    //
    // the day parameter should be in 1..31 range, for days 29, 30, 31 the
    // corresponding attribute is just unused if there is no such day in the
    // current month
    //
    // notice that currently arbitrary attributes are supported only in the
    // generic version, the native controls only support Mark() which assigns
    // some special appearance (which can be customized using SetMark() for the
    // generic version) to the given day

    virtual void Mark(size_t day, bool mark) = 0;

    virtual wxCalendarDateAttr *GetAttr(size_t WXUNUSED(day)) const
        { return NULL; }
    virtual void SetAttr(size_t WXUNUSED(day), wxCalendarDateAttr *attr)
        { delete attr; }
    virtual void ResetAttr(size_t WXUNUSED(day)) { }


    // holidays support
    //
    // currently only the generic version implements all functions in this
    // section; wxMSW implements simple support for holidays (they can be
    // just enabled or disabled) and wxGTK doesn't support them at all

    // equivalent to changing wxCAL_SHOW_HOLIDAYS flag but should be called
    // instead of just changing it
    virtual void EnableHolidayDisplay(bool display = true);

    // set/get the colours to use for holidays (if they're enabled)
    virtual void SetHolidayColours(const wxColour& WXUNUSED(colFg),
                                   const wxColour& WXUNUSED(colBg)) { }

    virtual const wxColour& GetHolidayColourFg() const { return wxNullColour; }
    virtual const wxColour& GetHolidayColourBg() const { return wxNullColour; }

    // mark the given day of the current month as being a holiday
    virtual void SetHoliday(size_t WXUNUSED(day)) { }


    // customizing the colours of the controls
    //
    // most of the methods in this section are only implemented by the native
    // version of the control and do nothing in the native ones

    // set/get the colours to use for the display of the week day names at the
    // top of the controls
    virtual void SetHeaderColours(const wxColour& WXUNUSED(colFg),
                                  const wxColour& WXUNUSED(colBg)) { }

    virtual const wxColour& GetHeaderColourFg() const { return wxNullColour; }
    virtual const wxColour& GetHeaderColourBg() const { return wxNullColour; }

    // set/get the colours used for the currently selected date
    virtual void SetHighlightColours(const wxColour& WXUNUSED(colFg),
                                     const wxColour& WXUNUSED(colBg)) { }

    virtual const wxColour& GetHighlightColourFg() const { return wxNullColour; }
    virtual const wxColour& GetHighlightColourBg() const { return wxNullColour; }


    // implementation only from now on

    // generate the given calendar event, return true if it was processed
    //
    // NB: this is public because it's used from GTK+ callbacks
    bool GenerateEvent(wxEventType type)
    {
        wxCalendarEvent event(this, GetDate(), type);
        return HandleWindowEvent(event);
    }

protected:
    // generate all the events for the selection change from dateOld to current
    // date: SEL_CHANGED, PAGE_CHANGED if necessary and also one of (deprecated)
    // YEAR/MONTH/DAY_CHANGED ones
    //
    // returns true if page changed event was generated, false if the new date
    // is still in the same month as before
    bool GenerateAllChangeEvents(const wxDateTime& dateOld);

    // call SetHoliday() for all holidays in the current month
    //
    // should be called on month change, does nothing if wxCAL_SHOW_HOLIDAYS is
    // not set and returns false in this case, true if we do show them
    bool SetHolidayAttrs();

    // called by SetHolidayAttrs() to forget the previously set holidays
    virtual void ResetHolidayAttrs() { }

    // called by EnableHolidayDisplay()
    virtual void RefreshHolidays() { }
};

// ----------------------------------------------------------------------------
// wxCalendarCtrl
// ----------------------------------------------------------------------------

#define wxCalendarNameStr "CalendarCtrl"

#ifndef __WXUNIVERSAL__
    #if defined(__WXGTK20__)
        #define wxHAS_NATIVE_CALENDARCTRL
        #include "wx/gtk/calctrl.h"
        #define wxCalendarCtrl wxGtkCalendarCtrl
    #elif defined(__WXMSW__)
        #define wxHAS_NATIVE_CALENDARCTRL
        #include "wx/msw/calctrl.h"
    #endif
#endif // !__WXUNIVERSAL__

#ifndef wxHAS_NATIVE_CALENDARCTRL
    #include "wx/generic/calctrlg.h"
    #define wxCalendarCtrl wxGenericCalendarCtrl
#endif

// ----------------------------------------------------------------------------
// calendar event types and macros for handling them
// ----------------------------------------------------------------------------

wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_SEL_CHANGED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_PAGE_CHANGED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_DOUBLECLICKED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_WEEKDAY_CLICKED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_WEEK_CLICKED, wxCalendarEvent )

// deprecated events
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_DAY_CHANGED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_MONTH_CHANGED, wxCalendarEvent )
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_YEAR_CHANGED, wxCalendarEvent )

typedef void (wxEvtHandler::*wxCalendarEventFunction)(wxCalendarEvent&);

#define wxCalendarEventHandler(func) \
    wxEVENT_HANDLER_CAST(wxCalendarEventFunction, func)

#define wx__DECLARE_CALEVT(evt, id, fn) \
    wx__DECLARE_EVT1(wxEVT_CALENDAR_ ## evt, id, wxCalendarEventHandler(fn))

#define EVT_CALENDAR(id, fn) wx__DECLARE_CALEVT(DOUBLECLICKED, id, fn)
#define EVT_CALENDAR_SEL_CHANGED(id, fn) wx__DECLARE_CALEVT(SEL_CHANGED, id, fn)
#define EVT_CALENDAR_PAGE_CHANGED(id, fn) wx__DECLARE_CALEVT(PAGE_CHANGED, id, fn)
#define EVT_CALENDAR_WEEKDAY_CLICKED(id, fn) wx__DECLARE_CALEVT(WEEKDAY_CLICKED, id, fn)
#define EVT_CALENDAR_WEEK_CLICKED(id, fn) wx__DECLARE_CALEVT(WEEK_CLICKED, id, fn)

// deprecated events
#define EVT_CALENDAR_DAY(id, fn) wx__DECLARE_CALEVT(DAY_CHANGED, id, fn)
#define EVT_CALENDAR_MONTH(id, fn) wx__DECLARE_CALEVT(MONTH_CHANGED, id, fn)
#define EVT_CALENDAR_YEAR(id, fn) wx__DECLARE_CALEVT(YEAR_CHANGED, id, fn)

#endif // wxUSE_CALENDARCTRL

#endif // _WX_CALCTRL_H_
Commit	Line	Data
9d9b7755 VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/calctrl.h
	3	// Purpose: date-picker control
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 29.12.99
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
65571936	9	// Licence: wxWindows licence
9d9b7755 VZ	10	///////////////////////////////////////////////////////////////////////////////
9d9b7755 VZ	11
1e6feb95 VZ	12	#ifndef _WX_CALCTRL_H_
	13	#define _WX_CALCTRL_H_
	14
	15	#include "wx/defs.h"
	16
	17	#if wxUSE_CALENDARCTRL
9d9b7755	18
feb72429	19	#include "wx/dateevt.h"
b1ef887a VS	20	#include "wx/colour.h"
b1ef887a VS	21	#include "wx/font.h"
628e155d	22	#include "wx/control.h"
4f6aed9c	23
37df1f33 VZ	24	// ----------------------------------------------------------------------------
	25	// wxCalendarCtrl flags
	26	// ----------------------------------------------------------------------------
	27
	28	enum
	29	{
	30	// show Sunday as the first day of the week (default)
	31	wxCAL_SUNDAY_FIRST = 0x0000,
	32
232b2162	33	// show Monday as the first day of the week
37df1f33 VZ	34	wxCAL_MONDAY_FIRST = 0x0001,
	35
	36	// highlight holidays
	37	wxCAL_SHOW_HOLIDAYS = 0x0002,
	38
	39	// disable the year change control, show only the month change one
628e155d	40	// deprecated
37df1f33 VZ	41	wxCAL_NO_YEAR_CHANGE = 0x0004,
	42
	43	// don't allow changing neither month nor year (implies
	44	// wxCAL_NO_YEAR_CHANGE)
	45	wxCAL_NO_MONTH_CHANGE = 0x000c,
	46
	47	// use MS-style month-selection instead of combo-spin combination
	48	wxCAL_SEQUENTIAL_MONTH_SELECTION = 0x0010,
	49
	50	// show the neighbouring weeks in the previous and next month
7b0ccb8a RR	51	wxCAL_SHOW_SURROUNDING_WEEKS = 0x0020,
	52
	53	// show week numbers on the left side of the calendar.
	54	wxCAL_SHOW_WEEK_NUMBERS = 0x0040
37df1f33 VZ	55	};
37df1f33 VZ	56
0185cd09 VZ	57	// ----------------------------------------------------------------------------
	58	// constants
	59	// ----------------------------------------------------------------------------
	60
	61	// return values for the HitTest() method
	62	enum wxCalendarHitTestResult
	63	{
	64	wxCAL_HITTEST_NOWHERE, // outside of anything
	65	wxCAL_HITTEST_HEADER, // on the header (weekdays)
37df1f33 VZ	66	wxCAL_HITTEST_DAY, // on a day in the calendar
	67	wxCAL_HITTEST_INCMONTH,
	68	wxCAL_HITTEST_DECMONTH,
232b2162 VZ	69	wxCAL_HITTEST_SURROUNDING_WEEK,
232b2162 VZ	70	wxCAL_HITTEST_WEEK
0185cd09 VZ	71	};
0185cd09 VZ	72
4f6aed9c VZ	73	// border types for a date
	74	enum wxCalendarDateBorder
	75	{
	76	wxCAL_BORDER_NONE, // no border (default)
	77	wxCAL_BORDER_SQUARE, // a rectangular border
	78	wxCAL_BORDER_ROUND // a round border
	79	};
	80
0185cd09	81	// ----------------------------------------------------------------------------
4f6aed9c	82	// wxCalendarDateAttr: custom attributes for a calendar date
0185cd09 VZ	83	// ----------------------------------------------------------------------------
0185cd09 VZ	84
12f190b0	85	class WXDLLIMPEXP_ADV wxCalendarDateAttr
4f6aed9c VZ	86	{
	87	public:
	88	// ctors
628e155d	89	wxCalendarDateAttr(const wxColour& colText = wxNullColour,
4f6aed9c VZ	90	const wxColour& colBack = wxNullColour,
	91	const wxColour& colBorder = wxNullColour,
	92	const wxFont& font = wxNullFont,
	93	wxCalendarDateBorder border = wxCAL_BORDER_NONE)
	94	: m_colText(colText), m_colBack(colBack),
	95	m_colBorder(colBorder), m_font(font)
	96	{
	97	Init(border);
	98	}
	99	wxCalendarDateAttr(wxCalendarDateBorder border,
	100	const wxColour& colBorder = wxNullColour)
	101	: m_colBorder(colBorder)
	102	{
	103	Init(border);
	104	}
	105
	106	// setters
	107	void SetTextColour(const wxColour& colText) { m_colText = colText; }
	108	void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
	109	void SetBorderColour(const wxColour& col) { m_colBorder = col; }
	110	void SetFont(const wxFont& font) { m_font = font; }
	111	void SetBorder(wxCalendarDateBorder border) { m_border = border; }
	112	void SetHoliday(bool holiday) { m_holiday = holiday; }
	113
	114	// accessors
	115	bool HasTextColour() const { return m_colText.Ok(); }
	116	bool HasBackgroundColour() const { return m_colBack.Ok(); }
	117	bool HasBorderColour() const { return m_colBorder.Ok(); }
	118	bool HasFont() const { return m_font.Ok(); }
	119	bool HasBorder() const { return m_border != wxCAL_BORDER_NONE; }
	120
	121	bool IsHoliday() const { return m_holiday; }
	122
	123	const wxColour& GetTextColour() const { return m_colText; }
	124	const wxColour& GetBackgroundColour() const { return m_colBack; }
	125	const wxColour& GetBorderColour() const { return m_colBorder; }
	126	const wxFont& GetFont() const { return m_font; }
	127	wxCalendarDateBorder GetBorder() const { return m_border; }
628e155d VZ	128
	129	// get or change the "mark" attribute, i.e. the one used for the items
	130	// marked with wxCalendarCtrl::Mark()
	131	static const wxCalendarDateAttr& GetMark() { return m_mark; }
	132	static void SetMark(wxCalendarDateAttr const& m) { m_mark = m; }
	133
006713a2	134	protected:
006713a2 DW	135	void Init(wxCalendarDateBorder border = wxCAL_BORDER_NONE)
	136	{
	137	m_border = border;
68379eaf	138	m_holiday = false;
006713a2	139	}
628e155d	140
4f6aed9c	141	private:
628e155d VZ	142	static wxCalendarDateAttr m_mark;
628e155d VZ	143
4f6aed9c VZ	144	wxColour m_colText,
	145	m_colBack,
	146	m_colBorder;
	147	wxFont m_font;
	148	wxCalendarDateBorder m_border;
	149	bool m_holiday;
	150	};
9d9b7755 VZ	151
	152	// ----------------------------------------------------------------------------
	153	// wxCalendarCtrl events
	154	// ----------------------------------------------------------------------------
	155
b5dbe15d	156	class WXDLLIMPEXP_FWD_ADV wxCalendarCtrl;
4f6aed9c	157
feb72429	158	class WXDLLIMPEXP_ADV wxCalendarEvent : public wxDateEvent
9d9b7755 VZ	159	{
9d9b7755 VZ	160	public:
628e155d VZ	161	wxCalendarEvent() : m_wday(wxDateTime::Inv_WeekDay) { }
	162	wxCalendarEvent(wxWindow *win, const wxDateTime& dt, wxEventType type)
	163	: wxDateEvent(win, dt, type),
7e7a19f1 FM	164	m_wday(wxDateTime::Inv_WeekDay) { }
	165	wxCalendarEvent(const wxCalendarEvent& event)
	166	: wxDateEvent(event), m_wday(event.m_wday) { }
9d9b7755	167
12ac619f	168	void SetWeekDay(const wxDateTime::WeekDay wd) { m_wday = wd; }
0185cd09 VZ	169	wxDateTime::WeekDay GetWeekDay() const { return m_wday; }
0185cd09 VZ	170
7e7a19f1 FM	171	virtual wxEvent Clone() const { return new wxCalendarEvent(this); }
7e7a19f1 FM	172
9d9b7755	173	private:
0185cd09	174	wxDateTime::WeekDay m_wday;
f6bcfd97	175
7e7a19f1	176	DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCalendarEvent)
9d9b7755 VZ	177	};
9d9b7755 VZ	178
628e155d VZ	179	// ----------------------------------------------------------------------------
	180	// wxCalendarCtrlBase
	181	// ----------------------------------------------------------------------------
	182
	183	class WXDLLIMPEXP_ADV wxCalendarCtrlBase : public wxControl
	184	{
	185	public:
	186	// do we allow changing the month/year?
	187	bool AllowMonthChange() const { return !HasFlag(wxCAL_NO_MONTH_CHANGE); }
	188
	189	// get/set the current date
	190	virtual wxDateTime GetDate() const = 0;
	191	virtual bool SetDate(const wxDateTime& date) = 0;
	192
	193
51317496 VZ	194	// restricting the dates shown by the control to the specified range: only
	195	// implemented in the generic and MSW versions for now
	196
	197	// if either date is set, the corresponding limit will be enforced and true
	198	// returned; if none are set, the existing restrictions are removed and
	199	// false is returned
	200	virtual bool
	201	SetDateRange(const wxDateTime& WXUNUSED(lowerdate) = wxDefaultDateTime,
	202	const wxDateTime& WXUNUSED(upperdate) = wxDefaultDateTime)
	203	{
	204	return false;
	205	}
	206
	207	// retrieves the limits currently in use (wxDefaultDateTime if none) in the
	208	// provided pointers (which may be NULL) and returns true if there are any
	209	// limits or false if none
	210	virtual bool
	211	GetDateRange(wxDateTime lowerdate, wxDateTime upperdate) const
	212	{
	213	if ( lowerdate )
	214	*lowerdate = wxDefaultDateTime;
	215	if ( upperdate )
	216	*upperdate = wxDefaultDateTime;
	217	return false;
	218	}
	219
628e155d VZ	220	// returns one of wxCAL_HITTEST_XXX constants and fills either date or wd
	221	// with the corresponding value (none for NOWHERE, the date for DAY and wd
	222	// for HEADER)
	223	//
	224	// notice that this is not implemented in all versions
	225	virtual wxCalendarHitTestResult
	226	HitTest(const wxPoint& WXUNUSED(pos),
	227	wxDateTime* WXUNUSED(date) = NULL,
	228	wxDateTime::WeekDay* WXUNUSED(wd) = NULL)
	229	{
	230	return wxCAL_HITTEST_NOWHERE;
	231	}
	232
	233	// allow or disable changing the current month (and year), return true if
	234	// the value of this option really changed or false if it was already set
	235	// to the required value
	236	//
	237	// NB: we provide implementation for this pure virtual function, derived
	238	// classes should call it
98ccd545	239	virtual bool EnableMonthChange(bool enable = true) = 0;
628e155d VZ	240
	241
	242	// an item without custom attributes is drawn with the default colours and
	243	// font and without border, setting custom attributes allows to modify this
	244	//
	245	// the day parameter should be in 1..31 range, for days 29, 30, 31 the
	246	// corresponding attribute is just unused if there is no such day in the
	247	// current month
	248	//
	249	// notice that currently arbitrary attributes are supported only in the
	250	// generic version, the native controls only support Mark() which assigns
	251	// some special appearance (which can be customized using SetMark() for the
	252	// generic version) to the given day
	253
	254	virtual void Mark(size_t day, bool mark) = 0;
	255
	256	virtual wxCalendarDateAttr *GetAttr(size_t WXUNUSED(day)) const
	257	{ return NULL; }
	258	virtual void SetAttr(size_t WXUNUSED(day), wxCalendarDateAttr *attr)
	259	{ delete attr; }
	260	virtual void ResetAttr(size_t WXUNUSED(day)) { }
	261
	262
bf956fac VZ	263	// holidays support
bf956fac VZ	264	//
6d9b6716 VZ	265	// currently only the generic version implements all functions in this
	266	// section; wxMSW implements simple support for holidays (they can be
	267	// just enabled or disabled) and wxGTK doesn't support them at all
bf956fac VZ	268
	269	// equivalent to changing wxCAL_SHOW_HOLIDAYS flag but should be called
	270	// instead of just changing it
6d9b6716	271	virtual void EnableHolidayDisplay(bool display = true);
bf956fac VZ	272
	273	// set/get the colours to use for holidays (if they're enabled)
	274	virtual void SetHolidayColours(const wxColour& WXUNUSED(colFg),
	275	const wxColour& WXUNUSED(colBg)) { }
	276
	277	virtual const wxColour& GetHolidayColourFg() const { return wxNullColour; }
	278	virtual const wxColour& GetHolidayColourBg() const { return wxNullColour; }
	279
	280	// mark the given day of the current month as being a holiday
	281	virtual void SetHoliday(size_t WXUNUSED(day)) { }
	282
	283
	284	// customizing the colours of the controls
	285	//
	286	// most of the methods in this section are only implemented by the native
	287	// version of the control and do nothing in the native ones
	288
	289	// set/get the colours to use for the display of the week day names at the
	290	// top of the controls
	291	virtual void SetHeaderColours(const wxColour& WXUNUSED(colFg),
	292	const wxColour& WXUNUSED(colBg)) { }
	293
	294	virtual const wxColour& GetHeaderColourFg() const { return wxNullColour; }
	295	virtual const wxColour& GetHeaderColourBg() const { return wxNullColour; }
	296
	297	// set/get the colours used for the currently selected date
	298	virtual void SetHighlightColours(const wxColour& WXUNUSED(colFg),
	299	const wxColour& WXUNUSED(colBg)) { }
	300
	301	virtual const wxColour& GetHighlightColourFg() const { return wxNullColour; }
	302	virtual const wxColour& GetHighlightColourBg() const { return wxNullColour; }
	303
	304
628e155d VZ	305	// implementation only from now on
628e155d VZ	306
b3ed7020	307	// generate the given calendar event, return true if it was processed
8354b47d VZ	308	//
8354b47d VZ	309	// NB: this is public because it's used from GTK+ callbacks
b3ed7020	310	bool GenerateEvent(wxEventType type)
628e155d VZ	311	{
628e155d VZ	312	wxCalendarEvent event(this, GetDate(), type);
b3ed7020	313	return HandleWindowEvent(event);
628e155d	314	}
a4fcd589	315
8354b47d	316	protected:
a4fcd589 VZ	317	// generate all the events for the selection change from dateOld to current
	318	// date: SEL_CHANGED, PAGE_CHANGED if necessary and also one of (deprecated)
	319	// YEAR/MONTH/DAY_CHANGED ones
6d9b6716 VZ	320	//
	321	// returns true if page changed event was generated, false if the new date
	322	// is still in the same month as before
	323	bool GenerateAllChangeEvents(const wxDateTime& dateOld);
	324
	325	// call SetHoliday() for all holidays in the current month
	326	//
	327	// should be called on month change, does nothing if wxCAL_SHOW_HOLIDAYS is
	328	// not set and returns false in this case, true if we do show them
	329	bool SetHolidayAttrs();
	330
	331	// called by SetHolidayAttrs() to forget the previously set holidays
	332	virtual void ResetHolidayAttrs() { }
	333
	334	// called by EnableHolidayDisplay()
	335	virtual void RefreshHolidays() { }
628e155d VZ	336	};
628e155d VZ	337
4f6aed9c VZ	338	// ----------------------------------------------------------------------------
	339	// wxCalendarCtrl
	340	// ----------------------------------------------------------------------------
	341
628e155d	342	#define wxCalendarNameStr "CalendarCtrl"
4f6aed9c	343
51317496 VZ	344	#ifndef __WXUNIVERSAL__
	345	#if defined(__WXGTK20__)
	346	#define wxHAS_NATIVE_CALENDARCTRL
	347	#include "wx/gtk/calctrl.h"
	348	#define wxCalendarCtrl wxGtkCalendarCtrl
	349	#elif defined(__WXMSW__)
	350	#define wxHAS_NATIVE_CALENDARCTRL
	351	#include "wx/msw/calctrl.h"
	352	#endif
	353	#endif // !__WXUNIVERSAL__
	354
	355	#ifndef wxHAS_NATIVE_CALENDARCTRL
628e155d VZ	356	#include "wx/generic/calctrlg.h"
	357	#define wxCalendarCtrl wxGenericCalendarCtrl
	358	#endif
feb72429	359
4f6aed9c	360	// ----------------------------------------------------------------------------
2e4df4bf	361	// calendar event types and macros for handling them
4f6aed9c VZ	362	// ----------------------------------------------------------------------------
4f6aed9c VZ	363
3c778901 VZ	364	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_SEL_CHANGED, wxCalendarEvent )
	365	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_PAGE_CHANGED, wxCalendarEvent )
	366	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_DOUBLECLICKED, wxCalendarEvent )
	367	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_WEEKDAY_CLICKED, wxCalendarEvent )
232b2162	368	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_WEEK_CLICKED, wxCalendarEvent )
628e155d VZ	369
628e155d VZ	370	// deprecated events
3c778901 VZ	371	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_DAY_CHANGED, wxCalendarEvent )
	372	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_MONTH_CHANGED, wxCalendarEvent )
	373	wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_CALENDAR_YEAR_CHANGED, wxCalendarEvent )
2e4df4bf	374
457e6c54 JS	375	typedef void (wxEvtHandler::*wxCalendarEventFunction)(wxCalendarEvent&);
457e6c54 JS	376
7fa03f04	377	#define wxCalendarEventHandler(func) \
3c778901	378	wxEVENT_HANDLER_CAST(wxCalendarEventFunction, func)
7fa03f04 VZ	379
	380	#define wx__DECLARE_CALEVT(evt, id, fn) \
	381	wx__DECLARE_EVT1(wxEVT_CALENDAR_ ## evt, id, wxCalendarEventHandler(fn))
	382
	383	#define EVT_CALENDAR(id, fn) wx__DECLARE_CALEVT(DOUBLECLICKED, id, fn)
	384	#define EVT_CALENDAR_SEL_CHANGED(id, fn) wx__DECLARE_CALEVT(SEL_CHANGED, id, fn)
628e155d VZ	385	#define EVT_CALENDAR_PAGE_CHANGED(id, fn) wx__DECLARE_CALEVT(PAGE_CHANGED, id, fn)
628e155d VZ	386	#define EVT_CALENDAR_WEEKDAY_CLICKED(id, fn) wx__DECLARE_CALEVT(WEEKDAY_CLICKED, id, fn)
232b2162	387	#define EVT_CALENDAR_WEEK_CLICKED(id, fn) wx__DECLARE_CALEVT(WEEK_CLICKED, id, fn)
628e155d VZ	388
628e155d VZ	389	// deprecated events
7fa03f04 VZ	390	#define EVT_CALENDAR_DAY(id, fn) wx__DECLARE_CALEVT(DAY_CHANGED, id, fn)
	391	#define EVT_CALENDAR_MONTH(id, fn) wx__DECLARE_CALEVT(MONTH_CHANGED, id, fn)
	392	#define EVT_CALENDAR_YEAR(id, fn) wx__DECLARE_CALEVT(YEAR_CHANGED, id, fn)
9d9b7755	393
1e6feb95 VZ	394	#endif // wxUSE_CALENDARCTRL
	395
	396	#endif // _WX_CALCTRL_H_
	397