[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 Monder 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
};

// 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
// ----------------------------------------------------------------------------

extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_SEL_CHANGED;
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_PAGE_CHANGED;
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_DOUBLECLICKED;
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_WEEKDAY_CLICKED;

// deprecated events
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_DAY_CHANGED;
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_MONTH_CHANGED;
extern WXDLLIMPEXP_ADV const wxEventType wxEVT_CALENDAR_YEAR_CHANGED;

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

#define wxCalendarEventHandler(func) \
    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(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)

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