ICoreApplication.cs :  » Network-Clients » iReaper » RssBandit » AppServices » C# / CSharp Open Source

#region CVS Version Header
/*
 * $Id: ICoreApplication.cs,v 1.1 2006/09/27 03:37:01 cvsuser Exp $
 * Last modified by $Author: cvsuser $
 * Last modified at $Date: 2006/09/27 03:37:01 $
 * $Revision: 1.1 $
 */
#endregion

using System;
using System.Collections;
using System.Net;
using NewsComponents;

namespace RssBandit.AppServices{
  /// <summary>
  /// ICoreApplication contains the core service functions 
  /// of RSS Bandit.
  /// </summary>
  public interface ICoreApplication
  {
    #region General
    /// <summary>
    /// Returns the current global (specified via options)
    /// Feed Refresh Rate in minutes.
    /// </summary>
    int CurrentGlobalRefreshRate { get; } 
    /// <summary>
    /// Gets the current application web proxy
    /// </summary>
    IWebProxy Proxy { get; }
    /// <summary>
    /// Gets the defined User Identities.
    /// Items are objects of type IUserIdentity, 
    /// keys are the correspondnig identity Name.
    /// </summary>
    IDictionary Identities { get; }
    /// <summary>
    /// Gets the defined NNTP News Server definitions.
    /// Items are objects of type INntpServerDefinition, 
    /// keys are the corresponding server Name.
    /// </summary>
    IDictionary NntpServerDefinitions { get; }
    /// <summary>
    /// Gets the groups of a defined NNTP server. This will be usually
    /// retrieved from a local cache, if available.
    /// </summary>
    /// <param name="nntpServerName">String. Name of the NNTP Server</param>
    /// <param name="forceReloadFromServer">If true, it loads the list of groups from the nntp server. If false,
    /// it will get them from local cache</param>
    /// <returns>list of strings: group names</returns>
    IList GetNntpNewsGroups(string nntpServerName, bool forceReloadFromServer);

    /// <summary>
    /// Gets the News Item Formatter Stylesheet list.
    /// </summary>
    /// <returns>list of strings.</returns>
    IList GetItemFormatterStylesheets();

    /// <summary>
    /// Gets the defined web search engines. 
    /// Items are of type ISearchEngine.
    /// </summary>
    IList WebSearchEngines { get ; }

    #endregion

    #region Dialogs
    /// <summary>
    /// Display the options dialog and select the desired detail section
    /// </summary>
    /// <param name="selectedSection">OptionDialogSection</param>
    /// <param name="optionsChangedHandler">A Change EventHandler</param>
    void ShowOptions(OptionDialogSection selectedSection, EventHandler optionsChangedHandler);
    /// <summary>
    /// Display the User Identity Management Dialog.
    /// </summary>
    /// <param name="definitionChangedHandler">A Change EventHandler</param>
    void ShowUserIdentityManagementDialog(EventHandler definitionChangedHandler);
    /// <summary>
    /// Display the NNTP Server Management Dialog.
    /// </summary>
    /// <param name="definitionChangedHandler">A Change EventHandler</param>
    void ShowNntpServerManagementDialog(EventHandler definitionChangedHandler);
    #endregion

    #region Url/Link navigation
    
    /// <summary>
    /// Navigates to an Url.
    /// </summary>
    /// <param name="url">Url to navigate to</param>
    /// <param name="tabCaption">The suggested tab caption (maybe replaced by the url's html page title)</param>
    /// <param name="forceNewTabOrWindow">Force to open a new Tab/Window</param>
    /// <param name="setFocus">Force to set the focus to the new Tab/Window</param>
    void NavigateToUrl(string url, string tabCaption, bool forceNewTabOrWindow, bool setFocus);

    /// <summary>
    /// Navigates to an provided Url on the user preferred Web Browser.
    /// So it may be the external OS Web Browser, or the internal one.
    /// </summary>
    /// <param name="url">Url to navigate to</param>
    /// <param name="tabCaption">The suggested tab caption (maybe replaced by the url's html page title)</param>
    /// <param name="forceNewTabOrWindow">Force to open a new Browser Window (Tab)</param>
    /// <param name="setFocus">Force to set the focus to the new Window (Tab)</param>
    void NavigateToUrlAsUserPreferred(string url, string tabCaption, bool forceNewTabOrWindow, bool setFocus);

    /// <summary>
    /// Navigates to an provided Url with help of the OS system preferred Web Browser.
    /// If it fails to navigate with that browser, it falls back to internal tabbed browsing.
    /// </summary>
    /// <param name="url">Url to navigate to</param>
    void NavigateToUrlInExternalBrowser(string url);

    #endregion

    #region Category management
    /// <summary>
    /// Gets the default category.
    /// </summary>
    string DefaultCategory { get; }
    /// <summary>
    /// Gets the list of categories including the default category.
    /// </summary>
    /// <returns></returns>
    string[] GetCategories();
    /// <summary>
    /// Use this method to add a new category.
    /// </summary>
    /// <param name="category"></param>
    void AddCategory(string category);
    #endregion

    #region Feeds management
    /// <summary>
    /// Call to subscribe to a new feed. This will initiate to
    /// display the Add Subscription Wizard with the parameters
    /// pre-set you provide.
    /// </summary>
    /// <param name="url">New feed Url</param>
    /// <returns></returns>
    bool SubscribeToFeed(string url);
    bool SubscribeToFeed(string url, string category);
    bool SubscribeToFeed(string url, string category, string title);

    /// <summary>
    /// Gets the Subscriptions Dictionary.
    /// </summary>
    IDictionary Subscriptions { get; }
    #endregion

  }
}