seb-win-refactoring/SafeExamBrowser.UserInterface.Contracts/Shell/ITaskbar.cs

90 lines
2.4 KiB
C#

/*
* Copyright (c) 2024 ETH Zürich, IT Services
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
using SafeExamBrowser.Browser.Contracts.Events;
using SafeExamBrowser.I18n.Contracts;
using SafeExamBrowser.UserInterface.Contracts.Shell.Events;
namespace SafeExamBrowser.UserInterface.Contracts.Shell
{
/// <summary>
/// The taskbar is a user interface element via which the user can access and control various aspects of the application.
/// </summary>
public interface ITaskbar
{
/// <summary>
/// Controls the visibility of the clock.
/// </summary>
bool ShowClock { set; }
/// <summary>
/// Controls the visibility of the quit button.
/// </summary>
bool ShowQuitButton { set; }
/// <summary>
/// Event fired when the user clicked the quit button in the taskbar.
/// </summary>
event QuitButtonClickedEventHandler QuitButtonClicked;
/// <summary>
/// Event fired when the Taskbar wants to lose focus.
/// </summary>
event LoseFocusRequestedEventHandler LoseFocusRequested;
/// <summary>
/// Adds the given application control to the taskbar.
/// </summary>
void AddApplicationControl(IApplicationControl control, bool atFirstPosition = false);
/// <summary>
/// Adds the given notification control to the taskbar.
/// </summary>
void AddNotificationControl(INotificationControl control);
/// <summary>
/// Adds the given system control to the taskbar.
/// </summary>
void AddSystemControl(ISystemControl control);
/// <summary>
/// Closes the taskbar.
/// </summary>
void Close();
/// <summary>
/// Puts the focus on the taskbar.
/// </summary>
void Focus(bool forward = true);
/// <summary>
/// Returns the absolute height of the taskbar (i.e. in physical pixels).
/// </summary>
int GetAbsoluteHeight();
/// <summary>
/// Moves the taskbar to the bottom of the screen and resizes it accordingly.
/// </summary>
void InitializeBounds();
/// <summary>
/// Initializes all text elements in the taskbar.
/// </summary>
void InitializeText(IText text);
/// <summary>
/// Registers the specified activator for the taskbar.
/// </summary>
void Register(ITaskbarActivator activator);
/// <summary>
/// Shows the taskbar.
/// </summary>
void Show();
}
}