C# Class Bloom.Shell

Show file Open project: BloomBooks/BloomDesktop

Public Properties

Property Type Description
QuitForSystemShutdown bool
QuitForVersionUpdate bool
UserWantsToOpeReopenProject bool

Public Methods

Method Description
DisplayProblemToUser ( string message ) : void

Display a dialog box that reports a problem to the user.

On Linux at least, displaying a dialog on a thread that is not the main GUI thread causes a crash with a segmentation violation. So we try to display on the main thread.

GetShortVersionInfo ( ) : string
ReallyComeToFront ( ) : void

we let the Program call this after it closes the splash screen

SetWindowText ( string bookName ) : void
Shell ( Func projectViewFactory, CollectionSettings collectionSettings, BookDownloadStartingEvent bookDownloadStartingEvent, LibraryClosing libraryClosingEvent, QueueRenameOfCollection queueRenameOfCollection, ControlKeyEvent controlKeyEvent ) : System

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

OnClosing ( CancelEventArgs e ) : void
OnHandleCreated ( EventArgs e ) : void
ProcessCmdKey ( Message &msg, Keys keyData ) : bool

Private Methods

Method Description
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

IsOnScreen ( Rectangle rect ) : bool

Is a significant (100 x 100) portion of the form on-screen?

On1024x586 ( object sender, EventArgs e ) : void
On1024x600Click ( object sender, EventArgs e ) : void
On1024x768 ( object sender, EventArgs e ) : void
On800x600Click ( object sender, EventArgs e ) : void
Shell_Activated ( object sender, EventArgs e ) : void
Shell_Deactivate ( object sender, EventArgs e ) : void
Shell_Load ( object sender, EventArgs e ) : void
Shell_ResizeEnd ( object sender, EventArgs e ) : void

Method Details

DisplayProblemToUser() public static method

Display a dialog box that reports a problem to the user.
On Linux at least, displaying a dialog on a thread that is not the main GUI thread causes a crash with a segmentation violation. So we try to display on the main thread.
public static DisplayProblemToUser ( string message ) : void
message string
return void

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

GetShortVersionInfo() public static method

public static GetShortVersionInfo ( ) : string
return string

OnClosing() protected method

protected OnClosing ( CancelEventArgs e ) : void
e CancelEventArgs
return void

OnHandleCreated() protected method

protected OnHandleCreated ( EventArgs e ) : void
e EventArgs
return void

ProcessCmdKey() protected method

protected ProcessCmdKey ( Message &msg, Keys keyData ) : bool
msg Message
keyData Keys
return bool

ReallyComeToFront() public method

we let the Program call this after it closes the splash screen
public ReallyComeToFront ( ) : void
return void

SetWindowText() public method

public SetWindowText ( string bookName ) : void
bookName string
return void

Shell() public method

public Shell ( Func projectViewFactory, CollectionSettings collectionSettings, BookDownloadStartingEvent bookDownloadStartingEvent, LibraryClosing libraryClosingEvent, QueueRenameOfCollection queueRenameOfCollection, ControlKeyEvent controlKeyEvent ) : System
projectViewFactory Func
collectionSettings CollectionSettings
bookDownloadStartingEvent BookDownloadStartingEvent
libraryClosingEvent LibraryClosing
queueRenameOfCollection QueueRenameOfCollection
controlKeyEvent ControlKeyEvent
return System

Property Details

QuitForSystemShutdown public property

public bool QuitForSystemShutdown
return bool

QuitForVersionUpdate public property

used when the user does an in-app installer download; after we close down, Program will read this and return control to Sparkle
public bool QuitForVersionUpdate
return bool

UserWantsToOpeReopenProject public property

public bool UserWantsToOpeReopenProject
return bool