The basic building block of the user interface.
Windows are the top-level elements in the UI hierarchy and the basic building blocks for a Pebble UI. A single window is always displayed at a time on Pebble, with the exception of when animating from one window to the other, which, in that case, is managed by the window stack. You can stack windows on top of each other, but only the topmost window will be visible.
Users wearing a Pebble typically interact with the content and media displayed in a window, clicking and pressing buttons on the watch, depending on what they see and wish to respond to in a window.
Windows serve to display a hierarchy of layers on the screen and handle user input. When a window is visible, its root Layer (and all its child layers) are drawn onto the screen automatically.
You need a window, which always fills the entire screen, to display images, text, and graphics in your Pebble app. A layer by itself doesn’t display on Pebble; it must be in the current window’s layer hierarchy to be visible.
The Window Stack serves as the global manager of what window is presented and makes sure that input events are forwarded to the topmost window.
Refer to the User Interface Layers chapter in the Pebble Developer Guides (chapter "Window") for a conceptual overview of Window, the Window Stack and relevant code examples.
A ready-made Window prompting the user to pick a number.
Creates a new Window on the heap and initalizes it with the default values.
Background color : GColorWhite
Root layer's update_proc : function that fills the window's background using background_color.
click_config_provider : NULL
window_handlers : all NULL
A pointer to the window. NULL if the window could not be created
Destroys a Window previously created by window_create.
Sets the click configuration provider callback function on the window. This will automatically setup the input handlers of the window as well to use the click recognizer subsystem.
The window for which to set the click config provider
The callback that will be called to configure the click recognizers with the window
Same as window_set_click_config_provider(), but will assign a custom context pointer (instead of the window pointer) that will be passed into the ClickHandler click event handlers.
The window for which to set the click config provider
The callback that will be called to configure the click recognizers with the window
Pointer to application specific data that will be passed to the click configuration provider callback (defaults to the window).
Gets the current click configuration provider of the window.
The window for which to get the click config provider
Gets the current click configuration provider context of the window.
The window for which to get the click config provider context
Sets the window handlers of the window. These handlers get called e.g. when the user enters or leaves the window.
The window for which to set the window handlers
The handlers for the specified window
Gets the root Layer of the window. The root layer is the layer at the bottom of the layer hierarchy for this window. It is the window's "canvas" if you will. By default, the root layer only draws a solid fill with the window's background color.
The window for which to get the root layer
The window's root layer
Sets the background color of the window, which is drawn automatically by the root layer of the window.
The window for which to set the background color
The new background color
Gets whether the window has been loaded. If a window is loaded, its .load handler has been called (and the .unload handler has not been called since).
The window to query its loaded status
true if the window is currently loaded or false if not.
Sets a pointer to developer-supplied data that the window uses, to provide a means to access the data at later times in one of the window event handlers.
The window for which to set the user data
A pointer to user data.
Gets the pointer to developer-supplied data that was previously set using window_set_user_data().
The window for which to get the user data
Subscribe to single click events.
Must be called from the ClickConfigProvider.
window_single_click_subscribe() and window_single_repeating_click_subscribe() conflict, and cannot both be used on the same button.
When there is a multi_click and/or long_click setup, there will be a delay before the single click
The button events to subscribe to.
The ClickHandler to fire on this event. handler will get fired. On the other hand, when there is no multi_click nor long_click setup, the single click handler will fire directly on button down.
Subscribe to single click event, with a repeat interval. A single click is detected every time "repeat_interval_ms" has been reached.
Must be called from the ClickConfigProvider.
window_single_click_subscribe() and window_single_repeating_click_subscribe() conflict, and cannot both be used on the same button.
The back button cannot be overridden with a repeating click.
The button events to subscribe to.
When holding down, how many milliseconds before the handler is fired again. A value of 0ms means "no repeat timer". The minimum is 30ms, and values below will be disregarded. If there is a long-click handler subscribed on this button, repeat_interval_ms will not be used.
The ClickHandler to fire on this event.
Subscribe to multi click events.
Must be called from the ClickConfigProvider.
The button events to subscribe to.
Minimum number of clicks before handler is fired. Defaults to 2.
Maximum number of clicks after which the click counter is reset. A value of 0 means use "min" also as "max".
The delay after which a sequence of clicks is considered finished, and the click counter is reset. A value of 0 means to use the system default 300ms.
Defaults to false. When true, only the handler for the last multi-click is called.
The ClickHandler to fire on this event. Fired for multi-clicks, as "filtered" by the last_click_only, min, and max parameters.
Subscribe to long click events.
Must be called from the ClickConfigProvider.
The back button cannot be overridden with a long click.
The button events to subscribe to.
Milliseconds after which "handler" is fired. A value of 0 means to use the system default 500ms.
The ClickHandler to fire as soon as the button has been held for delay_ms. This may be NULL to have no down handler.
The ClickHandler to fire on the release of a long click. This may be NULL to have no up handler.
Subscribe to raw click events.
Must be called from within the ClickConfigProvider.
The back button cannot be overridden with a raw click.
The button events to subscribe to.
The ClickHandler to fire as soon as the button has been pressed. This may be NULL to have no down handler.
The ClickHandler to fire on the release of the button. This may be NULL to have no up handler.
If this context is not NULL, it will override the general context.
Set the context that will be passed to handlers for the given button's events. By default the context passed to handlers is equal to the ClickConfigProvider context (defaults to the window).
Must be called from within the ClickConfigProvider.
The button to set the context for.
Set the context that will be passed to handlers for the given button's events.
WindowHandlers These handlers are called by the Window Stack as windows get pushed on / popped. All these handlers use WindowHandler as their function signature.
Called when the window is pushed to the screen when it's not loaded. This is a good moment to do the layout of the window.
Called when the window comes on the screen (again). E.g. when second-top-most window gets revealed (again) after popping the top-most window, but also when the window is pushed for the first time. This is a good moment to start timers related to the window, or reset the UI, etc.
Called when the window leaves the screen, e.g. when another window is pushed, or this window is popped. Good moment to stop timers related to the window.
Called when the window is deinited, but could be used in the future to free resources bound to windows that are not on screen.
Function signature for a handler that deals with transition events of a window.
Do you have questions about the Pebble SDK?
Do you need some help understanding something on this page?
You can either take advantage of our awesome developer community and check out the SDK Help forums, or you can send us a message through the website!