Class QuickPanelClient

View Source

Definition

Namespace:
Tizen.NUI.WindowSystem.Shell
Assembly:
Tizen.NUI.WindowSystem.dll

Class for the Tizen quickpanel client.


                
C#

                

                    
Copy

                    

                

            
public class QuickPanelClient : IDisposable
Inheritance
object
QuickPanelClient
Implements
System.IDisposable
Remarks

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.

Constructors

View Source

QuickPanelClient(TizenShell, IWindowProvider, Types)

The constructor of QuickPanelClass class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public QuickPanelClient(TizenShell tzShell, IWindowProvider win, QuickPanelClient.Types type)
Parameters
Type Name Description
TizenShell tzShell

The TizenShell instance.
IWindowProvider win

The window provider for the quickpanel service.
QuickPanelClient.Types type

The type of quickpanel service.
Remarks

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.

Exceptions
Type Condition
OutOfMemoryException

Thrown when there is not enough memory (to allocate).
System.ArgumentException

Thrown when failed of invalid argument.
System.ArgumentNullException

Thrown when an argument is null.
View Source

QuickPanelClient(TizenShell, Window, Types)

The constructor of QuickPanelClass class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public QuickPanelClient(TizenShell tzShell, Window win, QuickPanelClient.Types type)
Parameters
Type Name Description
TizenShell tzShell

The TizenShell instance.
Window win

The window to provide service of the quickpanel.
QuickPanelClient.Types type

The type of quickpanel service.
Remarks

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.

Exceptions
Type Condition
OutOfMemoryException

Thrown when the memory is not enough to allocate.
System.ArgumentException

Thrown when failed of invalid argument.
System.ArgumentNullException

Thrown when an argument is null.

Properties

View Source

Orientation

Gets the current orientation of the quickpanel service window.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Window.WindowOrientation Orientation { get; }
Property Value
Type Description
Window.WindowOrientation

The orientation of the quickpanel service window.
Remarks

Retrieves the orientation of the Quickpanel Service. This orientation value indicates the current angle of the Quickpanel Service window.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
System.InvalidOperationException

Thrown when failed because of an invalid operation or no service.
View Source

Scrollable

Gets or sets the window's scrollable state of the quickpanel service window.

Declaration

                
C#

                

                    
Copy

                    

                

            
public QuickPanelClient.ScrollableState Scrollable { get; set; }
Property Value
Type Description
QuickPanelClient.ScrollableState

The scrollable state of the quickpanel service window.
Remarks

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.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
System.InvalidOperationException

Thrown when failed because of an invalid operation or no service.
View Source

Visible

Gets the visible state of the quickpanel.

Declaration

                
C#

                

                    
Copy

                    

                

            
public QuickPanelClient.VisibleState Visible { get; }
Property Value
Type Description
QuickPanelClient.VisibleState

The visible state of the quickpanel service window.
Remarks

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.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
System.InvalidOperationException

Thrown when failed because of an invalid operation or no service.

Methods

View Source

Dispose()

Disposes the resources of the QuickPanelClient class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
Remarks

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.

Exceptions
Type Condition
System.MemberAccessException

Thrown when private memeber is a corrupted.
View Source

Dispose(DisposeTypes)

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Remarks

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.

View Source

~QuickPanelClient()

The destructor of QuickPanelClass class.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ~QuickPanelClient()
Remarks

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.

View Source

Hide()

Hides the quickpanel service window.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Hide()
Remarks

Change the visible state of the quickpanel service window to hidden.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
System.InvalidOperationException

Thrown when failed because of an invalid operation or no service.
View Source

Show()

Shows the quickpanel service window if it is currently scrollable.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Show()
Remarks

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.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
System.InvalidOperationException

Thrown when failed because of an invalid operation or no service.

Events

View Source

OrientationChanged

Emits the event when the orientation of the quickpanel service window is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<Window.WindowOrientation> OrientationChanged
Event Type
Type Description
System.EventHandler<TEventArgs><Window.WindowOrientation>
Remarks

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.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
View Source

RotationChanged

Emits the event when the rotation(orientation) of the quickpanel service window is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<int> RotationChanged
Event Type
Type Description
System.EventHandler<TEventArgs><int>
Remarks

The value of the event argument represents the rotation angle in degrees.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.
View Source

VisibleChanged

Emits the event when the visible state of the quickpanel service window is changed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<QuickPanelClient.VisibleState> VisibleChanged
Event Type
Type Description
System.EventHandler<TEventArgs><QuickPanelClient.VisibleState>
Remarks

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.

Exceptions
Type Condition
System.ArgumentException

Thrown when failed of invalid argument.

Implements

System.IDisposable