Win32::GUI::MonthCal - Create and manipulate MonthCal controls
[TBD]
Common methods apply to most windows, controls and resources.
new(PARENT, %OPTIONS)
Creates a new MonthCal object; can also be called as PARENT->AddMonthCal(%OPTIONS).
Class specific %OPTIONS are:
-daystate => 0/1 (default 0) Set/Unset daystate style. -multiselect => 0/1 (default 0) Set/Unset multiselect style. -notoday => 0/1 (default 0) Set/Unset notoday style. -notodaycircle => 0/1 (default 0) Set/Unset notodaycircle style. -weeknumber => 0/1 (default 0) Set/Unset weeknumber style.
See also the common options.
BackColor([COLOR])
Gets or sets the background color displayed between months.
BackMonthColor([COLOR])
Gets or sets the background color displayed within the month.
BackTitleColor([COLOR])
Gets or sets the background color displayed in the calendar's title.
GetColor(ICOLOR)
Retrieves the color for a given portion of a month calendar control.
ICOLOR :
MCSC_BACKGROUND = 0 : the background color (between months) MCSC_TEXT = 1 : the dates MCSC_TITLEBK = 2 : background of the title MCSC_TITLETEXT = 3 : text color of the title MCSC_MONTHBK = 4 : background within the month cal MCSC_TRAILINGTEXT = 5 : the text color of header & trailing days
GetCurSel()
Retrieves the currently selected date in a four elements array (year, month, day, dayofweek).
GetFirstDayOfWeek()
Retrieves the first day of the week for a month calendar control.
GetMaxSelCount()
Retrieves the maximum date range that can be selected in a month calendar control.
GetMaxTodayWidth()
Retrieves the maximum width of the "today" string in a month calendar control.
GetMinReqRect()
Retrieves the minimum size required to display a full month in a month calendar control
GetMonthDelta()
Retrieves the scroll rate for a month calendar control. The scroll rate is the number of months that the control moves its display when the user clicks a scroll button.
GetMonthRange([FLAG=GMR_DAYSTATE])
Retrieves date information that represents the high and low limits of a month calendar control's display. Return an array (yearmin, monthmin, daymin, dayofweekmin, yearmax, monthmax, daymax, dayofweekmax).
GetRange()
Retrieves the minimum and maximum allowable dates set for a month calendar control
GetRangeMax()
Retrieves the maximum allowable date set for a month calendar control
GetRangeMin()
Retrieves the minimum allowable date set for a month calendar control
GetSelRange()
Retrieves date information that represents the upper and lower limits of the date range currently selected by the user. Return an array (yearmin, monthmin, daymin, dayofweekmin, yearmax, monthmax, daymax, dayofweekmax).
GetToday()
Retrieves the date information for the date specified as "today" for a month calendar control. Return an array (year, month, day, dayofweek).
GetUnicodeFormat()
Retrieves the UNICODE character format flag for the control.
HitTest(X,Y)
Determines which portion of a month calendar control is at a given point on the screen.
SetColor(ICOLOR, COLOR)
Sets the color for a given portion of a month calendar control.
SetCurSel(YEAR, MON, DAY)
Sets the currently selected date for a month calendar control.
SetDayState([MONTHDAYSTATELIST])
Sets the day states for all months that are currently visible within a month calendar control. Each MONTHDAYSTATELIST items are an MONTHDAYSTATE. The MONTHDAYSTATE type is a bit field, where each bit (1 through 31) represents the state of a day in a month. If a bit is on, the corresponding day will be displayed in bold; otherwise it will be displayed with no emphasis.
SetFirstDayOfWeek(IDAY)
Sets the first day of the week for a month calendar control.
SetMaxSelCount(MAX)
Sets the maximum number of days that can be selected in a month calendar control.
SetMonthDelta(DELTA)
Sets the scroll rate for a month calendar control. The scroll rate is the number of months that the control moves its display when the user clicks a scroll button.
SetRange(YEARMIN,MONTHMIN,DAYMIN,YEARMAX,MONTHMAX,DAYMAX)
Sets the minimum and maximum allowable dates for a month calendar control.
SetRangeMax(YEAR, MONTH, DAY)
Sets the maximum allowable date for a month calendar control.
SetRangeMin(YEAR, MONTH, DAY)
Sets the minimum allowable date for a month calendar control.
SetSelRange(YEARMIN,MONTHMIN,DAYMIN,YEARMAX,MONTHMAX,DAYMAX)
Sets the selection for a month calendar control to a given date range.
SetToday(YEAR, MON, DAY)
Sets the "today" selection for a month calendar control.
SetUnicodeFormat(FLAG)
Sets the UNICODE character format flag for the control.
TextColor([COLOR])
Gets or sets the color used to display text within a month..
TitleTextColor([COLOR])
Gets or sets the color used to display text within the calendar's title.
TrailingTextColor([COLOR])
Gets or sets the color used to display header day and trailing day text. Header and trailing days are the days from the previous and following months that appear on the current month calendar.
Common events apply to most windows and controls.
DayState(YEAR,MONTH,DAY,MAXMONTH,MONTHDAYSTATELIST)
Sent by a month calendar control to request information about how individual days should be displayed.
MONTHDAYSTATELIST is array reference. Each MONTHDAYSTATELIST items are an MONTHDAYSTATE. The MONTHDAYSTATE type is a bit field, where each bit (1 through 31) represents the state of a day in a month. If a bit is on, the corresponding day will be displayed in bold; otherwise it will be displayed with no emphasis.
SelChange(YEARMIN,MONTMIN,DAYMIN,YEARMAX,MONTMAX,DAYMAX)
Sent by a month calendar control when the currently selected date or range of dates changes.
Select(YEARMIN,MONTMIN,DAYMIN,YEARMAX,MONTMAX,DAYMAX)
Sent by a month calendar control when the user makes an explicit date selection within a month calendar control.
Documentation for Win32::GUI v1.13 created 26 Jul 2016
This document is autogenerated by the build process. Edits made here will be lost. Edit docs/per_package.tpl instead.
Homepage: http://perl-win32-gui.sourceforge.net/.
For further support join the users mailing list from the website at http://lists.sourceforge.net/lists/listinfo/perl-win32-gui-users. There is a searchable list archive at http://sourceforge.net/p/perl-win32-gui/mailman/perl-win32-gui-users/.
Copyright (c) 1997..2016 Aldo Calpini. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Win32::GUI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Win32::GUI
CPAN shell
perl -MCPAN -e shell install Win32::GUI
For more information on module installation, please visit the detailed CPAN module installation guide.