EditStatusBar.h File Reference

Go to the source code of this file.

Functions
EFI_STATUS	StatusBarInit (VOID)
VOID	StatusBarCleanup (VOID)
EFI_STATUS	StatusBarRefresh (IN BOOLEAN EditorFirst, IN UINTN LastRow, IN UINTN LastCol, IN UINTN FileRow, IN UINTN FileCol, IN BOOLEAN InsertMode)
EFI_STATUS	StatusBarSetStatusString (IN CHAR16 *Str)
CONST CHAR16 *	StatusBarGetString (VOID)
VOID	StatusBarSetRefresh (VOID)
BOOLEAN	StatusBarGetRefresh (VOID)

Detailed Description

Declares statusbar interface functions.

Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EditStatusBar.h.

Function Documentation

StatusBarCleanup()

VOID StatusBarCleanup

(

VOID

)

Cleanup function for the status bar.

Definition at line 45 of file EditStatusBar.c.

StatusBarGetRefresh()

BOOLEAN StatusBarGetRefresh

(

VOID

)

Function to get the need refresh boolean to TRUE.

Return values

TRUE	The status bar needs to be refreshed.

Definition at line 221 of file EditStatusBar.c.

StatusBarGetString()

CONST CHAR16 * StatusBarGetString

(

VOID

)

Function to retrieve the current status string.

Returns

The string that is used.

Definition at line 197 of file EditStatusBar.c.

StatusBarInit()

EFI_STATUS StatusBarInit

(

VOID

)

Initialization function for Status Bar.

Return values

EFI_SUCCESS	The operation was successful.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

See also

StatusBarSetStatusString

Definition at line 24 of file EditStatusBar.c.

StatusBarRefresh()

EFI_STATUS StatusBarRefresh	(	IN BOOLEAN	EditorFirst,
		IN UINTN	LastRow,
		IN UINTN	LastCol,
		IN UINTN	FileRow,
		IN UINTN	FileCol,
		IN BOOLEAN	InsertMode
	)

Cause the status bar to refresh it's printing on the screen.

Parameters

[in]	EditorFirst	TRUE to indicate the first launch of the editor. FALSE otherwise.
[in]	LastRow	LastPrintable row.
[in]	LastCol	Last printable column.
[in]	FileRow	Row in the file.
[in]	FileCol	Column in the file.
[in]	InsertMode	TRUE to indicate InsertMode. FALSE otherwise.

Return values

EFI_SUCCESS

The operation was successful.

Definition at line 79 of file EditStatusBar.c.

StatusBarSetRefresh()

VOID StatusBarSetRefresh

(

VOID

)

Function to set the need refresh boolean to TRUE.

Definition at line 208 of file EditStatusBar.c.

StatusBarSetStatusString()

EFI_STATUS StatusBarSetStatusString

(

IN CHAR16 *

Str

)

Set the status string text part.

Parameters

[in]

Str

The string to use.

Return values

EFI_SUCCESS	The operation was successful.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

Definition at line 173 of file EditStatusBar.c.