This document is the development reference for Phosh 0.3.0

Phosh is a pure Wayland graphical shell for mobile devices.

If you find any issues in this development reference, please report it using the bugtracker.


I.
Widgets and Objects
PhoshActivity — An app in the faovorites overview
PhoshAppGridButton
PhoshAppGrid
PhoshAppListModel
PhoshArrow — An animated arrow
PhoshAuth — PAM authentication handling
PhoshBackgroundManager — Tracks screen related events and updates backgrounds accordingly.
PhoshBackground — The monitor's background
PhoshBatteryInfo — A widget to display the battery status
PhoshFader — A fader
PhoshFavoriteListModel
PhoshFeedbackManager — Sends and configures user feedback
PhoshFeedbackInfo — A widget to toggle feedback modes
PhoshHome — The home surface contains the overview and the button to fold and unfold the overview.
PhoshIdleManager — The idle manager singleton
PhoshLayerSurface
PhoshLockscreenManager — The singleton that manages screen locking
PhoshLockscreen — The main lock screen
PhoshLockshield — Lock shield for non primary screens
PhoshMonitorManager — The singleton that manages available monitors
PhoshMonitor — A monitor
PhoshNetworkAuthPrompt — A modal prompt for asking Network credentials
PhoshNotificationBanner — A floating notification
PhoshNotificationContent — Content of a notification
PhoshNotificationFrame — A frame containing one or more notifications
PhoshNotificationList — A list containing one or more PhoshNotificationSource
PhoshNotificationSource — A GListModel containing one or more notifications
PhoshNotification — A notification
PhoshNotifyManager — Provides the org.freedesktop.Notification DBus interface
PhoshOsk — A button that toggles the OSK
PhoshOskManager — A manager that handles the OSK
PhoshOverview — The overview shows running apps and the app grid to launch new applications.
PhoshPanel — The top panel
PhoshWayland — A wayland registry listener
PhoshWWan
PhoshWWanMM — Implementation of the PhoshWWanInterface
PhoshPolkitAuthAgent — PolicyKit Authentication Agent
PhoshPolkitAuthPrompt — A modal prompt for policy kit authentication
PhoshProximity — Proximity sensor handling
PhoshQuickSetting — A quick setting for the notification drawer
PhoshRotateInfo — A widget to display the rotate status
PhoshScreenSaverManager — Provides the org.gnome.ScreenSaver DBus interface
PhoshSensorProxyManager — Interface with iio-sensor-proxy
PhoshSession — Manages gnome-session registration and shutdown
PhoshSettings — The settings menu
ShellNetworkAgent
PhoshShell — The shell singleton
PhoshStatusIcon — Base clase for different status icons e.g in the top bar
PhoshSystemPrompt — A modal system prompt
PhoshSystemPrompter — Manages system prompter registration
PhoshToplevel — Represents a single toplevel surface.
PhoshToplevelManager — Tracks and interacts with toplevel surfaces for window management purposes.
PhoshWifiInfo — A widget to display the wifi status
PhoshWifiManager — Tracks the Wifi status and handle wifi credentials entry
PhoshWWanInfo — A widget to display the wwan status
Utilities
brightness
util
Generated DBus Servers
PhoshDisplayDbusDisplayConfigSkeleton
PhoshScreenSaverDbusScreenSaverSkeleton
PhoshNotifyDbusNotificationsSkeleton
PhoshSessionPresenceDbusPresenceSkeleton
Generated DBus Clients
PhoshIdleDbusObjectManagerClient
PhoshOsk0ObjectManagerClient
PhoshMMDBusObjectManagerClient
PhoshDbusSensorProxyCompassSkeleton
Wayland protocols
gamma-control-client-protocol
idle-client-protocol
phosh-private-client-protocol
wlr-foreign-toplevel-management-unstable-v1-client-protocol
wlr-input-inhibitor-unstable-v1-client-protocol
wlr-layer-shell-unstable-v1-client-protocol
wlr-output-management-unstable-v1-client-protocol
wlr-output-power-management-unstable-v1-client-protocol
xdg-output-unstable-v1-client-protocol
xdg-shell-client-protocol
II.
Object Hierarchy
API Index
Annotations glossary