GtkSharp/doc/en/Gtk/CalendarDisplayOptions.xml
Lee Mallabone b0b6e31e78 Simple docs for 2 enums.
svn path=/trunk/gtk-sharp/; revision=12720
2003-03-21 08:54:51 +00:00

102 lines
3.9 KiB
XML

<Type Name="CalendarDisplayOptions" FullName="Gtk.CalendarDisplayOptions">
<TypeSignature Language="C#" Value="public sealed struct CalendarDisplayOptions;" Maintainer="Lee Mallabone"/>
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Represents different styles and display options for a <see cref="T:Gtk.Calendar"/>.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IComparable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IConvertible</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IFormattable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="ShowHeading">
<MemberSignature Language="C#" Value="public static Gtk.CalendarDisplayOptions ShowHeading;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CalendarDisplayOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Specifies that the month and year should be displayed.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ShowDayNames">
<MemberSignature Language="C#" Value="public static Gtk.CalendarDisplayOptions ShowDayNames;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CalendarDisplayOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Specifies that three letter day descriptions should be present.</summary>
<remarks><para>In English these are, 'Mon', 'Tue', etc...</para></remarks>
</Docs>
</Member>
<Member MemberName="NoMonthChange">
<MemberSignature Language="C#" Value="public static Gtk.CalendarDisplayOptions NoMonthChange;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CalendarDisplayOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Prevents the user from switching months with the calendar.</summary>
<remarks><para>If retrieving a date from the user, this restricts them to only select a date from the displayed month.</para></remarks>
</Docs>
</Member>
<Member MemberName="ShowWeekNumbers">
<MemberSignature Language="C#" Value="public static Gtk.CalendarDisplayOptions ShowWeekNumbers;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CalendarDisplayOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Displays each week numbers of the current year, down the left side of the calendar.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WeekStartMonday">
<MemberSignature Language="C#" Value="public static Gtk.CalendarDisplayOptions WeekStartMonday;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CalendarDisplayOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Starts the calendar week on Monday, instead of the default Sunday.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="value__">
<MemberSignature Language="C#" Value="public int value__;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>