3
WYb                 @   s6   d dl mZ d dlT d dlT dgZG dd deZdS )    )Atspi)*Actionc               @   sX   e Zd ZdZdd Zdd Zdd Zdd	 Zd
d Zdd Z	dd Z
dZee
edZdS )r   a%  
        An interface through which a user-actionable user interface component
        can be manipulated. Components which react to mouse or keyboard
        input from the user, (with the exception of pure text entry fields
        with no other function), should implement this interface. Typical
        actions include "click", "press", "release" (for instance for
        buttons), "menu" (for objects which have context menus invokable
        from mouse or keyboard), "open" for icons representing files
        folders, and others.
        c             C   s   t jj| jS )z
                getActions:
                Retrieves all the actions at once.  
                @return : an array of an array of strings in the form
                [[name, description, keybinding], ...]
                )r   r   Zget_actionsobj)self r   0/usr/lib/python3/dist-packages/pyatspi/action.py
getActions&   s    zAction.getActionsc             C   s   t jj| j|S )a  
                doAction: 
                @param : index
                the 0-based index of the action to perform.
                Causes the object to perform the specified action.
                @return : a boolean indicating success or failure.
                )r   r   Z	do_actionr   )r   indexr   r   r   doAction/   s    zAction.doActionc             C   s   t jj| j|S )a  
                getDescription: 
                @param : index
                the index of the action for which a description is desired.
                Get the description of the specified action. The description
                of an action may provide information about the result of action
                invocation, unlike the action name. 
                @return : a string containing the description of the specified
                action.
                )r   r   Zget_action_descriptionr   )r   r
   r   r   r   getDescription9   s    zAction.getDescriptionc             C   s   t jj| j|S )a}  
                getKeyBinding: 
                @param : index
                the 0-based index of the action for which a key binding is requested.
                Get the key binding associated with a specific action.
                @return : a string containing the key binding for the specified
                action, or an empty string ("") if none exists.
                )r   r   Zget_key_bindingr   )r   r
   r   r   r   getKeyBindingF   s    	zAction.getKeyBindingc             C   s   t jj| j|S )a  
                getName: 
                @param : index
                the index of the action whose name is requested.
                Get the unlocalized name of the specified action. Action names
                generally describe the user action, i.e. "click" or "press",
                rather than the result of invoking the action.
                @return : a string containing the name of the specified action.
                )r   r   Zget_action_namer   )r   r
   r   r   r   getNameQ   s    
zAction.getNamec             C   s   t jj| j|S )a  
                getLocalizedName: 
                @param : index
                the index of the action whose name is requested.
                Get the localized name of the specified action. Action names
                generally describe the user action, i.e. "click" or "press",
                rather than the result of invoking the action.
                @return : a string containing the name of the specified action.
                )r   r   Zget_localized_namer   )r   r
   r   r   r   getLocalizedName]   s    
zAction.getLocalizedNamec             C   s   t jj| jS )N)r   r   Zget_n_actionsr   )r   r   r   r   get_nActionsi   s    zAction.get_nActionszy
                nActions: a long containing the number of actions this object
                supports.
                )fgetdocN)__name__
__module____qualname____doc__r	   r   r   r   r   r   r   Z_nActionsDocpropertyZnActionsr   r   r   r   r      s   
	
N)Zgi.repositoryr   Zpyatspi.utilsZpyatspi.interface__all__Z	interfacer   r   r   r   r   <module>   s   