Widget Application

The following table lists the callbacks you can use as the instance state changes.

Table: Instance state change callbacks

The following table lists the callbacks you can use as the instance state changes.

Table: Instance state change callbacks

1. To use the methods and properties of Tizen.NUI namespace, include it in your application:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   using Tizen.NUI;
   

2. Define your widget application class, which is inherited from NUIWidgetApplication class:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   class Program : NUIWidgetApplication
   

3. The widget application starts with Main(), which creates and initializes the application. Run() method of NUIWidgetApplication class is used to start the application event loop. NUIWidgetApplication class provides the two following kinds of constructors:

   • For using the NUIWidgetApplication(Type type) constructor, in case the widget application’s ID is the same as the application ID:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   static void Main(string[] args)
   {
       var app = new Program(typeof(MyWidget));
       app.Run(args);
   }
   

   • For using the NUIWidgetApplication(Dictionary< Type, string > typeInfo) constructor, in case your widget applications have multiple widget classes. For multiple instances, add <widget-class> in XML as follows:

   
                   
   XML
                   
   
                       
   Copy
                       
   
                   
               
       <widget-class classid="second" update-period="0">
       <support-size preview="Widget.png">2x2</support-size>
       </widget-class>
   

   You can then modify the code as follows:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   static void Main(string[] args)
   {
       Dictionary<System.Type, string> widgetSet = new Dictionary<Type, string>();
       widgetSet.Add(typeof(MyWidget), "second@org.tizen.example.WidgetTemplate");
       var app = new Program(widgetSet);
       app.Run(args);
   }
   

4. Define your widget class, which is inherited from Widget:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   class MyWidget : Widget
   

5. Override event callback methods of your new class:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   class MyWidget : Tizen.NUI.Widget
   {
     protected override void OnCreate(string contentInfo, Window window)
     {
       /// Create the UI
       /// ....
       base.OnCreate(contentInfo, window);
     }
   }
   

6. Drawing the widget UI in OnCreate():

   Initialize resources for this widget instance and draw the content on the screen.

   The widget UI is drawn in the OnCreate() callback of your widget class:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   protected override void OnCreate(string contentInfo, Window window)
   {
       View rootView = new View();
       rootView.BackgroundColor = Color.White;
       rootView.Size2D = window.Size;
       rootView.PivotPoint = PivotPoint.Center;
       window.GetDefaultLayer().Add(rootView);
   
       TextLabel sampleLabel = new TextLabel("Hello World!");
       sampleLabel.FontFamily = "SamsungOneUI 500";
       sampleLabel.PointSize = 71;
       sampleLabel.TextColor = Color.Black;
       sampleLabel.SizeWidth = 200;
       sampleLabel.PivotPoint = PivotPoint.Center;
   
       rootView.Add(sampleLabel);
   }
   

The widget application starts with the Main() function, which creates and initializes the application. The Run() method of the Tizen.Applications.WidgetApplication class is used to start the application event loop. The Tizen.Applications.WidgetApplication class provides 2 kinds of constructors:

• If you create the widget application with the WidgetApplication(Type type) constructor, that widget application’s ID is the same as the application ID.
• Using the WidgetApplication(IDictionary<Type, string> typeInfo) constructor, you can make widget applications with multiple widget classes.

1. To use the methods and properties of the Tizen.Applications namespace, include it in your application:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   using Tizen.Applications;
   

2. Define your widget class, which is inherited from the Tizen.Applications.WidgetBase class:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   class MyWidget : WidgetBase {}
   

3. Override the event callback methods of your new class:

   • The OnCreate() callback is triggered when the widget instance is created.

     Initialize resources for this widget instance and draw the UI. If bundle content is not NULL, restore the previous status:

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnCreate(Bundle content, int w, int h)
     {
         try
         {
             base.OnCreate(content, w, h);
             /// Recover the previous status with the bundle object
             /// Create the UI
         }
         catch (Exception e)
         {
             Log.Warn(_logTag, "exception " + e);
         }
     }
     

   • The OnDestroy() callback is triggered when the widget instance is destroyed.

     Release all widget resources. If the reason for the termination is not WidgetBase.WidgetDestroyType.Permanent, store the current status with the incoming bundle.

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnDestroy(WidgetBase.WidgetDestroyType reason, Bundle content)
     {
         if (reason != WidgetBase.WidgetDestroyType.Permanent)
             /// Save the current status at the bundle object
     }
     

   • The OnPause() callback is triggered when the widget instance is paused.

     Take the necessary actions when the widget instance becomes invisible. The framework can destroy a paused widget instance.

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnPause() {}
     

   • The OnResume() callback is triggered when the widget instance is resumed.

     Take the necessary actions when the widget instance becomes visible.

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnResume() {}
     

   • The OnResize() callback is triggered before the widget instance is resized.

     Take the necessary actions to accommodate the new size.

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnResize(int w, int h) {}
     

   • The OnUpdate() callback is triggered when a widget update event is received.

     Take the necessary actions for the widget update. If the isForce parameter is true, the widget can be updated even in the pause state.

     
                     
     C#
                     
     
                         
     Copy
                         
     
                     
                 
     public override void OnUpdate(Bundle content, bool isForce) {}
     

4. The widget UI is drawn in the OnCreate() callback of your widget class:

   
                   
   C#
                   
   
                       
   Copy
                       
   
                   
               
   public override void OnCreate(Bundle content, int w, int h)
   {
       try
       {
           base.OnCreate(content, w, h);
           Conformant conformant = new Conformant(Window);
           conformant.Show();
           Scroller scroller = new Scroller(Window)
           {
               AlignmentX = -1,
               AlignmentY = -1,
               WeightX = 1,
               WeightY = 1,
               ScrollBlock = ScrollBlock.None,
           };
           scroller.Show();
   
           Box box = new Box(Window)
           {
               AlignmentX = -1,
               AlignmentY = -1,
               WeightX = 1,
               WeightY = 1,
           };
           box.Show();
           scroller.SetContent(box);
           conformant.SetContent(scroller);
   
           Button exitButton = new Button(Window)
           {
               Text = "Exit Test",
               AlignmentX = -1,
               AlignmentY = -1,
               WeightX = 1,
               WeightY = 1
           };
           box.PackEnd(exitButton);
           exitButton.Show();
       }
       catch (Exception e)
       {
           Log.Warn(_logTag, "exception " + e);
       }
   }