src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 using Tizen.Applications.CoreBackend;
  20
  21 namespace Tizen.Applications
  22 {
  23     /// <summary>
  24     /// Class that represents an application controlled lifecycles by the backend system.
  25     /// </summary>
  26     public class CoreApplication : Application
  27     {
  28         private readonly ICoreBackend _backend;
  29         private bool _disposedValue = false;
  30
  31         /// <summary>
  32         /// Initializes the CoreApplication class.
  33         /// </summary>
  34         /// <param name="backend">The backend instance implementing ICoreBacked interface.</param>
  35         public CoreApplication(ICoreBackend backend)
  36         {
  37             _backend = backend;
  38         }
  39
  40         /// <summary>
  41         /// Occurs when the application is launched.
  42         /// </summary>
  43         public event EventHandler Created;
  44
  45         /// <summary>
  46         /// Occurs when the application is about to shutdown.
  47         /// </summary>
  48         public event EventHandler Terminated;
  49
  50         /// <summary>
  51         /// Occurs whenever the application receives the appcontrol message.
  52         /// </summary>
  53         public event EventHandler<AppControlReceivedEventArgs> AppControlReceived;
  54
  55         /// <summary>
  56         /// Occurs when the system memory is low.
  57         /// </summary>
  58         public event EventHandler<LowMemoryEventArgs> LowMemory;
  59
  60         /// <summary>
  61         /// Occurs when the system battery is low.
  62         /// </summary>
  63         public event EventHandler<LowBatteryEventArgs> LowBattery;
  64
  65         /// <summary>
  66         /// Occurs when the system language is chagned.
  67         /// </summary>
  68         public event EventHandler<LocaleChangedEventArgs> LocaleChanged;
  69
  70         /// <summary>
  71         /// Occurs when the region format is changed.
  72         /// </summary>
  73         public event EventHandler<RegionFormatChangedEventArgs> RegionFormatChanged;
  74
  75         /// <summary>
  76         /// The backend instance.
  77         /// </summary>
  78         protected ICoreBackend Backend { get { return _backend; } }
  79
  80         /// <summary>
  81         /// Runs the application's main loop.
  82         /// </summary>
  83         /// <param name="args">Arguments from commandline.</param>
  84         public override void Run(string[] args)
  85         {
  86             base.Run(args);
  87
  88             _backend.AddEventHandler(EventType.Created, OnCreate);
  89             _backend.AddEventHandler(EventType.Terminated, OnTerminate);
  90             _backend.AddEventHandler<AppControlReceivedEventArgs>(EventType.AppControlReceived, OnAppControlReceived);
  91             _backend.AddEventHandler<LowMemoryEventArgs>(EventType.LowMemory, OnLowMemory);
  92             _backend.AddEventHandler<LowBatteryEventArgs>(EventType.LowBattery, OnLowBattery);
  93             _backend.AddEventHandler<LocaleChangedEventArgs>(EventType.LocaleChanged, OnLocaleChanged);
  94             _backend.AddEventHandler<RegionFormatChangedEventArgs>(EventType.RegionFormatChanged, OnRegionFormatChanged);
  95
  96             _backend.Run(args);
  97         }
  98
  99         /// <summary>
 100         /// Exits the main loop of the application.
 101         /// </summary>
 102         public override void Exit()
 103         {
 104             _backend.Exit();
 105         }
 106
 107         /// <summary>
 108         /// Overrides this method if want to handle behavior when the application is launched.
 109         /// If base.OnCreated() is not called, the event 'Created' will not be emitted.
 110         /// </summary>
 111         protected virtual void OnCreate()
 112         {
 113             Created?.Invoke(this, EventArgs.Empty);
 114         }
 115
 116         /// <summary>
 117         /// Overrides this method if want to handle behavior when the application is terminated.
 118         /// If base.OnTerminate() is not called, the event 'Terminated' will not be emitted.
 119         /// </summary>
 120         protected virtual void OnTerminate()
 121         {
 122             Terminated?.Invoke(this, EventArgs.Empty);
 123         }
 124
 125         /// <summary>
 126         /// Overrides this method if want to handle behavior when the application receives the appcontrol message.
 127         /// If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be emitted.
 128         /// </summary>
 129         /// <param name="e"></param>
 130         protected virtual void OnAppControlReceived(AppControlReceivedEventArgs e)
 131         {
 132             AppControlReceived?.Invoke(this, e);
 133         }
 134
 135         /// <summary>
 136         /// Overrides this method if want to handle behavior when the system memory is low.
 137         /// If base.OnLowMemory() is not called, the event 'LowMemory' will not be emitted.
 138         /// </summary>
 139         protected virtual void OnLowMemory(LowMemoryEventArgs e)
 140         {
 141             LowMemory?.Invoke(this, e);
 142             System.GC.Collect();
 143         }
 144
 145         /// <summary>
 146         /// Overrides this method if want to handle behavior when the system battery is low.
 147         /// If base.OnLowBattery() is not called, the event 'LowBattery' will not be emitted.
 148         /// </summary>
 149         protected virtual void OnLowBattery(LowBatteryEventArgs e)
 150         {
 151             LowBattery?.Invoke(this, e);
 152         }
 153
 154         /// <summary>
 155         /// Overrides this method if want to handle behavior when the system language is changed.
 156         /// If base.OnLocaleChanged() is not called, the event 'LocaleChanged' will not be emitted.
 157         /// </summary>
 158         protected virtual void OnLocaleChanged(LocaleChangedEventArgs e)
 159         {
 160             LocaleChanged?.Invoke(this, e);
 161         }
 162
 163         /// <summary>
 164         /// Overrides this method if want to handle behavior when the region format is changed.
 165         /// If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted.
 166         /// </summary>
 167         protected virtual void OnRegionFormatChanged(RegionFormatChangedEventArgs e)
 168         {
 169             RegionFormatChanged?.Invoke(this, e);
 170         }
 171
 172         /// <summary>
 173         /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
 174         /// </summary>
 175         /// <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
 176         protected override void Dispose(bool disposing)
 177         {
 178             if (!_disposedValue)
 179             {
 180                 if (disposing)
 181                 {
 182                     _backend.Dispose();
 183                 }
 184
 185                 _disposedValue = true;
 186             }
 187             base.Dispose(disposing);
 188         }
 189     }
 190 }