Skip to main content

Visit Mozilla.org

nsIAppShell

From MDC


Contents

nsIAppShell is defined in widget/public/nsIAppShell.idl. It is Template:InterfaceStatus:Scriptable and unfrozen (hasn't changed since Mozilla 1111.9).

Inherits from: nsISupports

[edit] Method overview

void Create(inout int argc, inout string argv);
void Run();
void Spinup();
void Spindown();
void ListenToEventQueue(in nsIEventQueue aQueue, in PRBool aListen);
void GetNativeEvent(in PRBoolRef aRealEvent, in voidPtrRef aEvent);
void DispatchNativeEvent(in PRBool aRealEvent, in voidPtr aEvent);
void Exit();

[edit] Methods

[edit] Create()

Creates an application shell. 

 void Create(
   inout int argc, 
   inout string argv
 );
[edit] Parameters
argc
The number of parameters passed in on the command line.
argv
A direct reference to the parameter array.

[edit] Run()

Enter an event loop. Don't leave until application exists. 

 void Run();
[edit] Parameters

None.

[edit] Spinup()

Prepare to process events. 

 void Spinup();
[edit] Parameters

None.

[edit] Spindown()

Prepare to stop progressing events. 

 void Spinup();
[edit] Parameters

None.

[edit] ListenToEventQueue()

An event queue has been created or destroyed. Hook or unhook it from your system, as necessary. 

 void ListenToEventQueue(
   in nsIEventQueue aQueue, 
   in PRBool aListen
 );
[edit] Parameters
aQueue
The queue in question.
aListen
PR_TRUE for a new queue wanting hooking up. PR_FALSE for a queue wanting to be unhooked.

[edit] GetNativeEvent()

After event dispatch execute app specific code. 

 void GetNativeEvent(
   in PRBoolRef aRealEvent, 
   in voidPtrRef aEvent
 );
[edit] Parameters
aRealEvent
Event is real or a null placeholder (Macintosh).
aEvent
Void pointer to native event structure.

[edit] DispatchNativeEvent()

After event dispatch execute app specific code. 

 void DispatchNativeEvent(
   in PRBool aRealEvent, 
   in voidPtr aEvent
 );
[edit] Parameters
aRealEvent
Event is real or a null placeholder (Macintosh).
aEvent
Void pointer to native event structure.

[edit] Exit()

Exit the handle event loop. 

 void Exit();
[edit] Parameters

None.

Retrieved from "http://developer.mozilla.org/en/docs/nsIAppShell"