AppFrame

base class for application frame with main menu, status line, toolbars

Constructors

this
this()
Undocumented in source.

Members

Functions

applyShortcutsSettings
bool applyShortcutsSettings()
Undocumented in source. Be warned that the author may not have intended to support it.
createBody
Widget createBody()

create app body widget

createMainMenu
MainMenu createMainMenu()

create main menu

createStatusLine
StatusLine createStatusLine()

create app status line widget

createToolbars
ToolBarHost createToolbars()

create app toolbars

findKeyAction
Action findKeyAction(uint keyCode, uint flags)

map key to action

handleAction
bool handleAction(Action a)

override to handle specific actions

initialize
void initialize()
Undocumented in source. Be warned that the author may not have intended to support it.
onMenuItemAction
bool onMenuItemAction(Action action)

override to handle main menu actions

onMenuItemClick
bool onMenuItemClick(MenuItem item)

override to handle main menu commands

onTimer
bool onTimer(ulong timerId)

timer handler

saveShortcutsSettings
bool saveShortcutsSettings(const(Action)[] actions)

set shortcut settings from actions and save to file - useful for initial settings file version creation

setBackgroundOperation
void setBackgroundOperation(BackgroundOperationWatcher op)

set background operation to show in status

updateShortcuts
void updateShortcuts()

override it

Properties

appCodeName
string appCodeName [@property getter]

override to return some identifier for app, e.g. to use as settings directory name

appCodeName
string appCodeName [@property setter]

override to return some identifier for app, e.g. to use as settings directory name

frameBody
Widget frameBody [@property getter]

body widget

mainMenu
MainMenu mainMenu [@property getter]

main menu widget

settingsDir
string settingsDir [@property getter]

Application settings directory; by default, returns .appcodename directory in user's home directory (e.g. /home/user/.appcodename, C:\Users\User\AppData\Roaming\.appcodename); override to change it

shortcutSettings
SettingsFile shortcutSettings [@property getter]

returns shortcuts settings object

statusLine
StatusLine statusLine [@property getter]

status line widget

toolbars
ToolBarHost toolbars [@property getter]

tool bar host

Variables

_appName
string _appName;
Undocumented in source.
_body
Widget _body;
Undocumented in source.
_currentBackgroundOperation
BackgroundOperationWatcher _currentBackgroundOperation;
Undocumented in source.
_currentBackgroundOperationTimer
ulong _currentBackgroundOperationTimer;
Undocumented in source.
_mainMenu
MainMenu _mainMenu;
Undocumented in source.
_settingsDir
string _settingsDir;
Undocumented in source.
_shortcutSettings
SettingsFile _shortcutSettings;
Undocumented in source.
_statusLine
StatusLine _statusLine;
Undocumented in source.
_toolbarHost
ToolBarHost _toolbarHost;
Undocumented in source.

Inherited Members

From MenuItemClickHandler

onMenuItemClick
bool onMenuItemClick(MenuItem item)
Undocumented in source.

From MenuItemActionHandler

onMenuItemAction
bool onMenuItemAction(Action action)
Undocumented in source.

Meta