Clipz - A Friendly Introduction to the Windows 7 Taskbar Features

//Copyright (c) Microsoft Corporation.  All rights reserved.
using System;
using Microsoft.WindowsAPICodePack.Controls.WindowsForms;

namespace Microsoft.WindowsAPICodePack.Controls
{

    /// <summary>
    /// These options control the results subsequent navigations of the ExplorerBrowser
    /// </summary>
    public class ExplorerBrowserNavigationOptions
    {
        #region construction
        ExplorerBrowser eb;
        internal ExplorerBrowserNavigationOptions( ExplorerBrowser eb )
        {
            this.eb = eb;
            PaneVisibility = new ExplorerBrowserPaneVisibility( );
        }
        #endregion

        #region Flags property
        /// <summary>
        /// The binary flags that are passed to the explorer browser control's GetOptions/SetOptions methods
        /// </summary>
        public ExplorerBrowserNavigationFlags Flags
        {
            get
            {
                EXPLORER_BROWSER_OPTIONS ebo = new EXPLORER_BROWSER_OPTIONS( );
                if( eb.explorerBrowserControl != null )
                {
                    eb.explorerBrowserControl.GetOptions( out ebo );
                    return (ExplorerBrowserNavigationFlags)ebo;
                }
                return (ExplorerBrowserNavigationFlags)ebo;
            }
            set
            {
                EXPLORER_BROWSER_OPTIONS ebo = (EXPLORER_BROWSER_OPTIONS)value;
                if( eb.explorerBrowserControl != null )
                {
                    // Always forcing SHOWFRAMES because we handle IExplorerPaneVisibility
                    eb.explorerBrowserControl.SetOptions( ebo | EXPLORER_BROWSER_OPTIONS.EBO_SHOWFRAMES );
                }
            }
        }
        #endregion

        #region control flags to properties mapping
        /// <summary>
        /// Do not navigate further than the initial navigation.
        /// </summary>
        public bool NavigateOnce
        {
            get
            {
                return IsFlagSet( ExplorerBrowserNavigationFlags.NavigateOnce );
            }
            set
            {
                SetFlag( ExplorerBrowserNavigationFlags.NavigateOnce, value );
            }
        }
        /// <summary>
        /// Always navigate, even if you are attempting to navigate to the current folder.
        /// </summary>
        public bool AlwaysNavigate
        {
            get
            {
                return IsFlagSet( ExplorerBrowserNavigationFlags.AlwaysNavigate );
            }
            set
            {
                SetFlag( ExplorerBrowserNavigationFlags.AlwaysNavigate, value );
            }
        }

        private bool IsFlagSet( ExplorerBrowserNavigationFlags flag )
        {
            return ( Flags & flag ) != 0;
        }

        private void SetFlag( ExplorerBrowserNavigationFlags flag, bool value )
        {
            if( value )
                Flags |= flag;
            else
                Flags = Flags & ~flag;
        }
        #endregion

        #region ExplorerBrowser pane visibility
        /// <summary>
        /// Controls the visibility of the various ExplorerBrowser panes on subsequent navigation
        /// </summary>
        public ExplorerBrowserPaneVisibility PaneVisibility
        {
            get;
            private set;
        }

        #endregion
    }
}