screwturn-4/PluginFramework/ContextInformation.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.Web;

namespace ScrewTurn.Wiki.PluginFramework {

	/// <summary>
	/// Contains information about the Context of the page formatting.
	/// </summary>
	public class ContextInformation {

		private bool forIndexing;
		private bool forWysiwyg;
		private FormattingContext context;
		private PageInfo page;
		private string language;
		private HttpContext httpContext;
		private string username;
		private string[] groups;

		/// <summary>
		/// Initializes a new instance of the <b>FormatContext</b> class.
		/// </summary>
		/// <param name="forIndexing">A value indicating whether the formatting is being done for content indexing.</param>
		/// <param name="forWysiwyg">A value indicating whether the formatting is being done for display in the WYSIWYG editor.</param>
		/// <param name="context">The formatting context.</param>
		/// <param name="page">The Page Information, if any, <c>null</c> otherwise.</param>
		/// <param name="language">The current Thread's language (for example "en-US").</param>
		/// <param name="httpContext">The current HTTP Context object.</param>
		/// <param name="username">The current User's Username (or <c>null</c>).</param>
		/// <param name="groups">The groups the user is member of (or <c>null</c>).</param>
		public ContextInformation(bool forIndexing, bool forWysiwyg, FormattingContext context, PageInfo page, string language, HttpContext httpContext, string username, string[] groups) {
			this.forIndexing = forIndexing;
			this.forWysiwyg = forWysiwyg;
			this.context = context;
			this.page = page;
			this.language = language;
			this.httpContext = httpContext;
			this.username = username;
			this.groups = groups;
		}

		/// <summary>
		/// Gets a value indicating whether the formatting is being done for content indexing.
		/// </summary>
		public bool ForIndexing {
			get { return forIndexing; }
		}

		/// <summary>
		/// Gets a value indicating whether the formatting is being done for display in the WYSIWYG editor.
		/// </summary>
		public bool ForWysiwyg {
			get { return forWysiwyg; }
		}

		/// <summary>
		/// Gets the formatting context.
		/// </summary>
		public FormattingContext Context {
			get { return context; }
		}

		/// <summary>
		/// Gets the Page Information.
		/// </summary>
		public PageInfo Page {
			get { return page; }
		}

		/// <summary>
		/// Gets the current Thread's Language (for example en-US).
		/// </summary>
		public string Language {
			get { return language; }
		}

		/// <summary>
		/// Gets the current HTTP Context object.
		/// </summary>
		public HttpContext HttpContext {
			get { return httpContext; }
		}

		/// <summary>
		/// Gets the Username of the current User (or <c>null</c>).
		/// </summary>
		/// <remarks>If the Username is not available, the return value is <c>null</c>.</remarks>
		public string Username {
			get { return username; }
		}

		/// <summary>
		/// Gets the groups the user is member of (or <c>null</c>).
		/// </summary>
		public string[] Groups {
			get { return groups; }
		}

	}

	/// <summary>
	/// Lists formatting contexts.
	/// </summary>
	public enum FormattingContext {
		/// <summary>
		/// The overall header.
		/// </summary>
		Header,
		/// <summary>
		/// The overall footer.
		/// </summary>
		Footer,
		/// <summary>
		/// The sidebar.
		/// </summary>
		Sidebar,
		/// <summary>
		/// The page header.
		/// </summary>
		PageHeader,
		/// <summary>
		/// The page footer.
		/// </summary>
		PageFooter,
		/// <summary>
		/// The page content.
		/// </summary>
		PageContent,
		/// <summary>
		/// Transcluded page content.
		/// </summary>
		TranscludedPageContent,
		/// <summary>
		/// The body of a message.
		/// </summary>
		MessageBody,
		/// <summary>
		/// Any other context.
		/// </summary>
		Other,
		/// <summary>
		/// No know context.
		/// </summary>
		Unknown
	}

}