From 2f069bbf8ad40ad40cdc916847f0f6c20625cd5b Mon Sep 17 00:00:00 2001 From: Junseok Kim Date: Fri, 11 Oct 2024 11:51:31 +0900 Subject: [PATCH] [NUI.WindowSystem] TizenShell: Enhance API description Signed-off-by: Junseok Kim --- .../src/public/QuickPanelClient.cs | 45 ++++++++++++++++--- .../src/public/TizenShell.cs | 14 +++--- 2 files changed, 48 insertions(+), 11 deletions(-) diff --git a/src/Tizen.NUI.WindowSystem/src/public/QuickPanelClient.cs b/src/Tizen.NUI.WindowSystem/src/public/QuickPanelClient.cs index 40e0c984e57..a8cf9036a44 100644 --- a/src/Tizen.NUI.WindowSystem/src/public/QuickPanelClient.cs +++ b/src/Tizen.NUI.WindowSystem/src/public/QuickPanelClient.cs @@ -27,6 +27,10 @@ namespace Tizen.NUI.WindowSystem.Shell /// /// Class for the Tizen quickpanel client. /// + /// + /// TizenShell.QuickPanelClient is a specialized class designed for handling interactions with the Quickpanel service that Tizen system GUI Application. + /// Through this class, we can conveniently retrieve various states of the Quickpanel service and make changes to specific states when necessary. + /// /// 8 public class QuickPanelClient : IDisposable { @@ -123,8 +127,10 @@ public event EventHandler OrientationChanged /// /// Emits the event when the rotation(orientation) of the quickpanel service window is changed. - /// The value of the event argument represents the rotation angle in degrees. /// + /// + /// The value of the event argument represents the rotation angle in degrees. + /// /// Thrown when failed of invalid argument. /// 12 public event EventHandler RotationChanged @@ -230,6 +236,7 @@ public enum ScrollableState /// /// Enumeration for orientation state of quickpanel service window. /// + /// 8 private enum OrientationState { /// @@ -255,8 +262,12 @@ private enum OrientationState } /// - /// Creates a new Quickpanel Client handle. + /// The constructor of QuickPanelClass class. /// + /// + /// This constructor creates a new Quickpanel Client handle. with this handle, we can interact with the quickpanel service window. + /// This handle needs the TizenShell handle first. + /// /// The TizenShell instance. /// The window to provide service of the quickpanel. /// The type of quickpanel service. @@ -295,8 +306,12 @@ public QuickPanelClient(TizenShell tzShell, Window win, Types type) } /// - /// Creates a new Quickpanel Client handle. + /// The constructor of QuickPanelClass class. /// + /// + /// This constructor creates a new Quickpanel Client handle. with this handle, we can interact with the quickpanel service. + /// This handle needs the TizenShell handle first. + /// /// The TizenShell instance. /// The window provider for the quickpanel service. /// The type of quickpanel service. @@ -335,7 +350,7 @@ public QuickPanelClient(TizenShell tzShell, IWindowProvider win, Types type) } /// - /// Destructor. + /// The destructor of QuickPanelClass class. /// /// 8 ~QuickPanelClient() @@ -348,7 +363,7 @@ public QuickPanelClient(TizenShell tzShell, IWindowProvider win, Types type) } /// - /// Dispose. + /// Disposes the resources of the QuickPanelClient class. /// /// Thrown when private memeber is a corrupted. /// 8 @@ -460,6 +475,10 @@ private void OnOrientationChanged(int type, IntPtr ev_info, IntPtr data) /// /// Gets the visible state of the quickpanel. /// + /// + /// Retrieves the visible state of the Quickpanel Service. + /// This visible state indicates whether or not the Quickpanel Service window is displayed at the time of invocation. + /// /// The visible state of the quickpanel service window. /// Thrown when failed of invalid argument. /// Thrown when failed because of an invalid operation or no service. @@ -487,6 +506,11 @@ private VisibleState GetVisible() /// /// Gets or sets the window's scrollable state of the quickpanel service window. /// + /// + /// Retrieves or Changes the scrollable state of the Quickpanel Service window. + /// The scrollableState determines whether the Quickpanel Service window is scrollable or not. + /// And the scrollableState can be affect the visibility of the Quickpanel Service window. + /// /// The scrollable state of the quickpanel service window. /// Thrown when failed of invalid argument. /// Thrown when failed because of an invalid operation or no service. @@ -527,6 +551,10 @@ private void SetScrollable(ScrollableState scroll) /// /// Gets the current orientation of the quickpanel service window. /// + /// + /// Retrieves the orientation of the Quickpanel Service. + /// This orientation value indicates the current angle of the Quickpanel Service window. + /// /// The orientation of the quickpanel service window. /// Thrown when failed of invalid argument. /// Thrown when failed because of an invalid operation or no service. @@ -556,6 +584,10 @@ private Window.WindowOrientation GetOrientation() /// /// Shows the quickpanel service window if it is currently scrollable. /// + /// + /// Change the visible state of the quickpanel service window to shown if it is currently scrollable. + /// If the quickpanel is not scrollable, nothing will happen. + /// /// Thrown when failed of invalid argument. /// Thrown when failed because of an invalid operation or no service. /// 8 @@ -570,6 +602,9 @@ public void Show() /// /// Hides the quickpanel service window. /// + /// + /// Change the visible state of the quickpanel service window to hidden. + /// /// Thrown when failed of invalid argument. /// Thrown when failed because of an invalid operation or no service. /// 8 diff --git a/src/Tizen.NUI.WindowSystem/src/public/TizenShell.cs b/src/Tizen.NUI.WindowSystem/src/public/TizenShell.cs index d2e6be16d3a..b453f8900af 100644 --- a/src/Tizen.NUI.WindowSystem/src/public/TizenShell.cs +++ b/src/Tizen.NUI.WindowSystem/src/public/TizenShell.cs @@ -24,10 +24,12 @@ namespace Tizen.NUI.WindowSystem.Shell { /// - /// Tizen Window System Shell. - /// This is a basic handle class for others in WsShell. - /// Others class in WsShell using this basic class to use TIzen Window System Shell. + /// Basic handle of Tizen Window System Shell. /// + /// + /// This class is a basic handle class for other class in Tizen Window System Shell. + /// TizenShell serves as the entry point for interacting with the other subclass of Tizen Window System Shell. + /// /// 8 public class TizenShell : IDisposable { @@ -68,7 +70,7 @@ internal void ErrorCodeThrow(int error) } /// - /// Creates a new Tizen Shell handle. + /// The constructor of TizenShell class. /// /// Thrown when the memory is not enough to allocate. /// Thrown when failed of invalid argument. @@ -84,7 +86,7 @@ public TizenShell() } /// - /// Destructor. + /// The destructor of TizenShell class. /// /// 8 ~TizenShell() @@ -97,7 +99,7 @@ public TizenShell() } /// - /// Dispose. + /// Dispose the TizenShell instance explicitly. /// /// Thrown when private memeber is a corrupted. /// 8