Class CCApplication

The CCApplication class is the main class that controls the app run loop, handles events, and manages the lifecycle of the program.

Hierarchy (View Summary)

Constructors

constructor

Properties

acceptsFirstResponder appearance? appIcon? delegate isActive isHidden isRunning keyWindow? mainWindow? modalWindow? nextResponder? windows wmConnection shared

Accessors

currentEvent menu

Methods

abortModal activate becomeFirstResponder cursorPos deactivate discardEvents finishLaunching hide horizontalScrollWheel interpretKeyEvents keyDown keyUp mouseDown mouseDragged mouseEntered mouseExited mouseMoved mouseUp nextEvent noResponder otherMouseDown otherMouseDragged otherMouseUp postEvent presentError replyToApplicationShouldTerminate resignFirstResponder rightMouseDown rightMouseDragged rightMouseUp run runModal scrollWheel sendEvent showAboutWindow showCharacterPalette showColorPicker stop stopModal terminate textInput tryToCall unhide updateWindows validateProposedFirstResponder

Constructors

constructor

Properties

acceptsFirstResponder

acceptsFirstResponder: boolean = true

Whether the object can become the first responder.

Optionalappearance

appearance?: CCAppearance

The desired appearance of the app.

OptionalappIcon

appIcon?: CCImage

The icon for the app.

delegate

delegate: CCApplicationDelegate

A delegate object to receive lifecycle notifications.

isActive

isActive: boolean = false

Whether the current app is the active app.

isHidden

isHidden: boolean = false

Whether the app is currently hidden.

isRunning

isRunning: boolean = false

Whether the main loop is currently running.

OptionalkeyWindow

keyWindow?: CCWindow

The key window, which gets input events.

OptionalmainWindow

mainWindow?: CCWindow

The main window of the application.

OptionalmodalWindow

modalWindow?: CCWindow

The modal window being displayed, if it exists.

OptionalnextResponder

nextResponder?: CCResponder

The next responder in the responder chain.

windows

windows: CCWindow[] = []

A list of all windows in the application.

wmConnection

wmConnection: CCWindowManagerConnection

The connection to the window manager for the app.

Staticshared

shared: CCApplication

The CCApplication instance for the current app.

Accessors

currentEvent

menu

Methods

abortModal

activate

  • activate(ignoreOtherApps: boolean): void

  • Activates the app.

    Parameters

    • ignoreOtherApps: boolean

      If false, will not activate if another app is already active

    Returns void

becomeFirstResponder

cursorPos

  • cursorPos(): undefined | [CCPoint, number]

  • This is used to place a blinking cursor on screen while not drawing. It's only called on the first responder of a window.

    Returns undefined | [CCPoint, number]

    The position and color of the cursor in window coordinates, or undefined to not place a cursor

deactivate

discardEvents

  • discardEvents(matching: string, before?: CCEvent): void

  • Discards any event matching the specified event name, optionally only before another event.

    Parameters

    • matching: string

      The event name to match

    • Optionalbefore: CCEvent

      If provided, only events before this event will be removed

    Returns void

finishLaunching

  • finishLaunching(): void

  • Called to activate the application before starting the main loop.

    Returns void

hide

  • hide(): void

  • Hides the app from the screen, activating the next app.

    Returns void

horizontalScrollWheel

interpretKeyEvents

  • interpretKeyEvents(events: CCEvent[]): void

  • Sends a list of key input events to the input manager, which will send back text input events through insertText(text: string).

    Parameters

    • events: CCEvent[]

      The input events to send

    Returns void

keyDown

keyUp

mouseDown

mouseDragged

mouseEntered

mouseExited

mouseMoved

mouseUp

nextEvent

  • nextEvent(matching: string, dequeue: boolean): undefined | CCEvent

  • Returns the first event in the queue which matches the specified name.

    Parameters

    • matching: string

      The event name to match

    • dequeue: boolean

      Whether to pop the event from the queue

    Returns undefined | CCEvent

    The matching event, or null if not found

noResponder

  • noResponder(method: string): void

  • Handles when a method action fails to find a responder.

    Parameters

    • method: string

      The method that was attempted

    Returns void

otherMouseDown

otherMouseDragged

otherMouseUp

postEvent

  • postEvent(event: CCEvent, atStart: boolean): void

  • Adds an event to the event queue, to be processed by the run loop.

    Parameters

    • event: CCEvent

      The event to queue

    • atStart: boolean

      Whether to add it to the front of the queue

    Returns void

presentError

  • presentError(error: CCError, window?: CCWindow, callback?: () => void): void

  • Displays an error message in a popup window.

    Parameters

    • error: CCError

      The error to show

    • Optionalwindow: CCWindow

      If specified, a window to show the error as a modal on

    • Optionalcallback: () => void

      If specified, a function to call when the popup appears on screen

    Returns void

replyToApplicationShouldTerminate

  • replyToApplicationShouldTerminate(terminate: boolean): void

  • Follows up to a previous response from the app delegate to delay termination.

    Parameters

    • terminate: boolean

      Whether to terminate the app now

    Returns void

resignFirstResponder

rightMouseDown

rightMouseDragged

rightMouseUp

run

  • run(): void

  • Run the main event loop.

    Returns void

    Throws

    If the event loop is already running.

runModal

  • runModal(window: CCWindow): ModalResponse

  • Runs a modal event loop for a window, pausing event processing until the window is closed and the modal state is cleared.

    Parameters

    • window: CCWindow

      The modal window to show

    Returns ModalResponse

    A response code indicating how the modal exited

scrollWheel

sendEvent

showAboutWindow

  • showAboutWindow(
        options?: {
            build?: number;
            credits?: string;
            icon?: CCImage;
            name?: string;
            version?: string;
        },
    ): void

  • Shows an About window for the app.

    Parameters

    • Optionaloptions: {
          build?: number;
          credits?: string;
          icon?: CCImage;
          name?: string;
          version?: string;
      }

      Any options to pass to the window

    Returns void

showCharacterPalette

  • showCharacterPalette(): void

  • Shows a character palette window.

    Returns void

showColorPicker

stop

stopModal

terminate

  • terminate(): void

  • Sends a notification to terminate the app.

    Returns void

textInput

tryToCall

  • tryToCall(method: string, ...args: any[]): boolean

  • Attempts to call the specified method on the object, passing the call on to the next responder if this object doesn't implement it.

    Parameters

    • method: string

      The name of the method to call

    • ...args: any[]

      Any parameters to pass to the method

    Returns boolean

    Whether a responder was able to respond to the method

unhide

  • unhide(activate?: boolean): void

  • Unhides and (optionally) activates the app.

    Parameters

    • Optionalactivate: boolean

      Whether to also activate the app

    Returns void

updateWindows

  • updateWindows(): void

  • Updates all windows in the application.

    Returns void

validateProposedFirstResponder

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods