X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2FApplicationGuide.md;h=7066e50c678427ce248b56c8b5a696062fda7733;hb=refs%2Ftags%2Fhalibut%2F8.0.1;hp=ae6ab0a9dfbb4f0682b28a9e5ff10b00148d5bcb;hpb=d4b18f9152860b4fd8746e5098a75ad56dba1c7f;p=apps%2Fagl-service-windowmanager.git diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md index ae6ab0a..7066e50 100644 --- a/doc/ApplicationGuide.md +++ b/doc/ApplicationGuide.md @@ -1,25 +1,25 @@ -# **Window Manager Application Guide** +# Window Manager Application Guide ## Table of content -- [Target reader of this document](#Target\ reader\ of\ this\ document) -- [Overview](#Overview) - - [Supported usecase](#Supported\ usecase) -- [Getting Started](#Getting\ Started) - - [Build](#Build) - - [Install](#Install) - - [Bitbake](#Bitbake) - - [Enable to call Window Manager](#Enable\ to\ call\ Window\ Manager) -- [Software Architecture](#Software\ Architecture) -- [Sequence](#Sequence) -- [API reference](#API\ reference) - - [Request to Window Manager](#Request\ to\ Window\ Manager) - - [Event from Window Manager](#Event\ from\ Window\ Manager) - - [Client Library](#Client\ library) -- [Sample code](#Sample\ code) -- [Policy Manager](#Policy\ Manager) - - [Enabling split](#Enabling\ split) -- [Release Note](#Release\ Note) +- [Target reader of this document](#target-reader-of-this-document) +- [Overview](#overview) + - [Supported usecase](#supported-usecase) +- [Getting Started](#getting-started) + - [Build](#build-by-sdk) + - [Install](#install) + - [Bitbake](#bitbake) + - [Enable to call Window Manager](#enable-to-call-window-manager) +- [Software Architecture](#software-architecture) +- [Sequence](#sequence) +- [API reference](#api-reference) + - [Request to Window Manager](#request-to-window-manager) + - [Event from Window Manager](#event-from-window-manager) + - [Client Library](#client-library) +- [Sample code](#sample-code) +- [Policy Manager](#policy-manager) + - [Enabling split](#enabling-split) +- [Release Note](#release-note) | Version | Author | Updated at | |:-:|:-:|:-:| @@ -48,7 +48,7 @@ It does not include Framework](https://wiki.automotivelinux.org/agl-distro/app-framework). - document of HomeScreen, see - [HomeScreen](http://docs.automotivelinux.org/docs/apis_services/en/dev/reference/hmi-framework/3_1-HomeScreen-Guide.html). + [HomeScreen](./ApplicationGuide.html). It is highly recommended to have a good understanding of these documents and projects before using Window manager. @@ -57,7 +57,7 @@ and projects before using Window manager. # Overview -Window Manager is the service process which provides **window management based on policy**. +Window Manager is the service process which provides window management based on policy. And implements a layout switching of applications on multiple layers and with different layer layouts. Window Manager is based on ivi layer management from GENIVI and AGL application framework. @@ -79,12 +79,12 @@ In this example, there are two mode for window management. The important points are: -- **Window transition should be done by Window Manager** +- Window transition should be done by Window Manager Window Manager switch application displayed on top layer by user operation(touch shortcut button). In this example, when an user touches `navigation` shortcut button, Window Manager displays `navigation` and hide `launcher`. Next, when an user touches `videoplayer` shortcut button, Window Manager divides a screen into two parts and display two applications. -- **There is a priority `role` for each application.** +- There is a priority `role` for each application. Window Manager realizes state transition change based on the policy which consists of `role`. According to the state transition table, it controls the visibility of application window, layout change, and so on. @@ -178,7 +178,7 @@ This library provides a function style API calling interface. So you can include the libwindowmanager.hpp header file, and can link against this library. Please also refer to the sample application. -See also our [Sample code](#Sample\ code). +See also our [Sample code](#sample-code). * * * @@ -851,7 +851,7 @@ Typical implementation of Qt application. - Repo: `git clone https://gerrit.automotivelinux.org/gerrit/apps/radio` - Repo: `git clone https://gerrit.automotivelinux.org/gerrit/apps/videoplayer` -This is the good example to write more simply for Qt application using QtAGLExtra. +This is the good example to write more simply for Qt application using QtAGLExtras. ## Policy Manager