EditTitleBar.h File Reference

Go to the source code of this file.

Enumerations
enum	EDIT_FILE_TYPE {   FileTypeNone , FileTypeAscii , FileTypeUnicode , FileTypeDiskBuffer ,   FileTypeMemBuffer , FileTypeFileBuffer }

Functions
EFI_STATUS	MainTitleBarInit (CONST CHAR16 *Prompt)
VOID	MainTitleBarCleanup (VOID)
EFI_STATUS	MainTitleBarRefresh (IN CONST CHAR16 *FileName OPTIONAL, IN CONST EDIT_FILE_TYPE FileType, IN CONST BOOLEAN ReadOnly, IN CONST BOOLEAN Modified, IN CONST UINTN LastCol, IN CONST UINTN LastRow, IN CONST UINTN Offset, IN CONST UINTN Size)

Detailed Description

Declares titlebar interface functions.

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

Definition in file EditTitleBar.h.

Enumeration Type Documentation

EDIT_FILE_TYPE

enum EDIT_FILE_TYPE

Definition at line 33 of file EditTitleBar.h.

Function Documentation

MainTitleBarCleanup()

VOID MainTitleBarCleanup

(

VOID

)

Clean up the memory used.

Definition at line 49 of file EditTitleBar.c.

MainTitleBarInit()

EFI_STATUS MainTitleBarInit

(

CONST CHAR16 *

Prompt

)

Initialize a title bar.

Parameters

[in]

Prompt

The prompt to print in the title bar.

Return values

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

Definition at line 24 of file EditTitleBar.c.

MainTitleBarRefresh()

EFI_STATUS MainTitleBarRefresh	(	IN CONST CHAR16 *FileName	OPTIONAL,
		IN CONST EDIT_FILE_TYPE	FileType,
		IN CONST BOOLEAN	ReadOnly,
		IN CONST BOOLEAN	Modified,
		IN CONST UINTN	LastCol,
		IN CONST UINTN	LastRow,
		IN CONST UINTN	Offset,
		IN CONST UINTN	Size
	)

Refresh function for MainTitleBar

Parameters

[in]	FileName	The open file's name (or NULL).
[in]	FileType	The type fo the file.
[in]	ReadOnly	TRUE if the file is read only. FALSE otherwise.
[in]	Modified	TRUE if the file was modified. FALSE otherwise.
[in]	LastCol	The last printable column.
[in]	LastRow	The last printable row.
[in]	Offset	The offset into the file. (only for mem/disk)
[in]	Size	The file's size. (only for mem/disk)

Return values

EFI_SUCCESS

The operation was successful.

Definition at line 82 of file EditTitleBar.c.