G@d)V0dZddlmZmZmZddlmZddlmZm Z m Z m Z ddl m Z ddlmZddlmZddlmZdd lmZdd lmZmZdd lmZmZmZmZGd d ZGddZGddZ GddZ!Gdde!e e eZ"dS)z Spyder API Mixins. )AnyOptionalDict)Qt) QSizePolicyQToolBarQWidget QToolButton)SpyderConfigurationObserver)SpyderAPIError SpyderMenu)CONF)ima) create_actioncreate_toolbutton)ACTION_REGISTRY MENU_REGISTRYTOOLBAR_REGISTRYTOOLBUTTON_REGISTRYc eZdZdZ d dZ d dedeedeed efd Z d deedeed e eeffd Z dS)SpyderToolButtonMixinz= Provide methods to create, add and get toolbuttons. NTFc |rt|sd}| | | |j} t||d||||||| | ||j|jd} || _|r.| ,| *t j| | } | | | S)z- Create a Spyder toolbutton. cdSNvalues 9lib/python3.11/site-packages/spyder/api/widgets/mixins.pyz9SpyderToolButtonMixin.create_toolbutton..-DNT)textshortcuticontiptoggled triggered autoraisetext_beside_iconsectionoptionid_plugin context_nameregister_toolbutton) callable CONF_SECTIONr PLUGIN_NAME CONTEXT_NAMEnamerget setChecked) selfr5r#r%r&r'r(r)r*r+r, toolbuttonrs rrz'SpyderToolButtonMixin.create_toolbutton%s  )8G,, )((G  6#5+& -#* $   "   -"v'9&11%%e,,,r"r5contextr.returncZ||jn|}||jn|}tj|||S)a/ Return toolbutton by name, plugin and context. Parameters ---------- name: str Name of the toolbutton to retrieve. context: Optional[str] Widget or context identifier under which the toolbutton was stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the toolbutton was defined. If None, then `PLUGIN_NAME` is used. Returns ------- toolbutton: QToolButton The corresponding toolbutton stored under the given `name`, `context` and `plugin`. Raises ------ KeyError If either of `name`, `context` or `plugin` keys do not exist in the toolbutton registry. )r3r4r get_referencer8r5r:r.s rget_toolbuttonz$SpyderToolButtonMixin.get_toolbuttonMs;8&,^!!'.$##G"0vwGGGr"cX||jn|}||jn|}tj||S)a_ Return all toolbuttons defined by a context on a given plugin. Parameters ---------- context: Optional[str] Widget or context identifier under which the toolbuttons were stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the toolbuttons were defined. If None, then `PLUGIN_NAME` is used. Returns ------- toolbuttons: Dict[str, QToolButton] A dictionary that maps string keys to their corresponding toolbuttons. )r3r4rget_referencesr8r:r.s rget_toolbuttonsz%SpyderToolButtonMixin.get_toolbuttonsms9(&,^!!'.$##G"1&'BBBr") NNNNNTFNNNN) __name__ __module__ __qualname____doc__rstrrr r?rrCrr"rrr s7;<@;@/3&&&&PBF/3HH3H#H'}H8CHHHH@8<04CCx}C ( C9=c;>N9OCCCCCCr"rc eZdZdZ d dZd dZdedefdZ d dede ed e edefd Z d de ed e ede eeffd Z dS)SpyderToolbarMixinz: Provide methods to create, add and get toolbars. Nc6||||dS)z If you provide a `before` action, the action will be placed before this one, so the section option will be ignored, since the action will now be placed in the same section as the `before` action. r+beforeN)add_item)r8action_or_widgettoolbarr+rNs radd_item_to_toolbarz&SpyderToolbarMixin.add_item_to_toolbars& )76JJJJJr"ct}|tjtj|||_|S)zG Create a stretcher widget to be used in a Qt toolbar. )r setSizePolicyr ExpandingID)r8r- stretchers rcreate_stretcherz#SpyderToolbarMixin.create_stretchers;II  5{7LMMM ?ILr"r5r;cft|}tj|||j|j|S)z* Create a Spyder toolbar. )rrregister_referencer3r4)r8r5rQs rcreate_toolbarz!SpyderToolbarMixin.create_toolbars;4..+ T4+T-> @ @ @r"r:r.cZ||jn|}||jn|}tj|||S)a Return toolbar by name, plugin and context. Parameters ---------- name: str Name of the toolbar to retrieve. context: Optional[str] Widget or context identifier under which the toolbar was stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the toolbar was defined. If None, then `PLUGIN_NAME` is used. Returns ------- toolbar: QToolBar The corresponding toolbar stored under the given `name`, `context` and `plugin`. Raises ------ KeyError If either of `name`, `context` or `plugin` keys do not exist in the toolbar registry. )r3r4rr=r>s r get_toolbarzSpyderToolbarMixin.get_toolbars;8&,^!!'.$##G-dFGDDDr"cX||jn|}||jn|}tj||S)aA Return all toolbars defined by a context on a given plugin. Parameters ---------- context: Optional[str] Widget or context identifier under which the toolbars were stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the toolbars were defined. If None, then `PLUGIN_NAME` is used. Returns ------- toolbars: Dict[str, QToolBar] A dictionary that maps string keys to their corresponding toolbars. )r3r4rrArBs r get_toolbarszSpyderToolbarMixin.get_toolbarss9&&,^!!'.$##G.vw???r"rDr) rErFrGrHrRrXrIrr[rr]rr_rr"rrKrKsFJ#'KKKK    38?C,0EEEhsmE$SME5=EEEE@59-1@@HSM@%c]@6:3=6I@@@@@@r"rKc eZdZdZ d dZd dZ d dedeedeedefd Z d deedeede eeffd Z dS) SpyderMenuMixinz Provide methods to create, add and get menus. This mixin uses a custom menu object that allows for the creation of sections in a simple way. Nc~t|tstd||||dS)z> Add a SpyderAction or a QWidget to the menu. z'Menu must be an instance of SpyderMenu!rMN) isinstancerr add_action)r8action_or_menumenur+rNs radd_item_to_menuz SpyderMenuMixin.add_item_to_menusD $ ++ L !JKK K GGGGGr"cddlm}||||}|<|d||t j|||j|j|S)a7 Create a menu. Parameters ---------- name: str Unique str identifier. text: str or None Localized text string. icon: QIcon or None Icon to use for the menu. Return: QMenu Return the created menu. rr )parenttitlemenu_idNT) spyder.api.widgets.menusr menuActionsetIconVisibleInMenusetIconrrZr3r4)r8r5r#r%rrfs r create_menuzSpyderMenuMixin.create_menus 877777zT4@@@   OO   2 24 8 8 8 LL   ( $($*; = = = r"r5r:r.r;cZ||jn|}||jn|}tj|||S)a Return a menu by name, plugin and context. Parameters ---------- name: str Name of the menu to retrieve. context: Optional[str] Widget or context identifier under which the menu was stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the menu was defined. If None, then `PLUGIN_NAME` is used. Returns ------- menu: SpyderMenu The corresponding menu stored under the given `name`, `context` and `plugin`. Raises ------ KeyError If either of `name`, `context` or `plugin` keys do not exist in the menu registry. )r3r4rr=r>s rget_menuzSpyderMenuMixin.get_menu s;8&,^!!'.$##G*4AAAr"cX||jn|}||jn|}tj||S)a4 Return all menus defined by a context on a given plugin. Parameters ---------- context: Optional[str] Widget or context identifier under which the menus were stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the menus were defined. If None, then `PLUGIN_NAME` is used. Returns ------- menus: Dict[str, SpyderMenu] A dictionary that maps string keys to their corresponding menus. )r3r4rrArBs r get_menuszSpyderMenuMixin.get_menus-s9&&,^!!'.$##G+FG<<B $HHHH6<@)-BBSB8C=B!#B2<BBBB@26*.==#="3-=37Z3H======r"raceZdZdZdZddddddejdddddddddfdZ dded e ed e ed e fd Z dd e ed e ed e fd Z dZdS)SpyderActionMixinzw Provide methods to create, add and get actions in a unified way. This mixin uses a custom action object. c|d |||n#t$rYnwxYw|ddS)a This allows to update the state of a togglable action without emitting signals. This is useful when the global application configuration changes and we need to propagate the current state of an action based on those changes TFN) blockSignals get_actionr7r )r8 action_namers r_update_action_statez&SpyderActionMixin._update_action_stateLsz $  OOK ( ( 3 3E : : : :    D  %     s(A A  A NFTc||td||}|rt|sd}| | | |j} t||||||| | | ||j||jn||||}||_|r||t||_ ||_ | |_ ||_ | *|r| | nB|rtdn0|r.| ,| *tj| | }| ||S)a name: str unique identifiable name for the action text: str Localized text for the action icon: QIcon, Icon for the action when applied to menu or toolbutton. icon_text: str Icon for text in toolbars. If True, this will also disable the tooltip on this toolbutton if part of a toolbar. tip: str Tooltip to define for action on menu or toolbar. toggled: Optional[Union[Callable, bool]] If True, then the action modifies the configuration option on the section specified. Otherwise, it should be a callable to use when toggling this action. If None, then the action does not behave like a checkbox. triggered: callable The callable to use when triggering this action. shortcut_context: str Set the `str` context of the shortcut. context: Qt.ShortcutContext Set the context for the shortcut. initial: object Sets the initial state of a togglable action. This does not emit the toggled signal. section: Optional[str] Name of the configuration section whose option is going to be modified. If None, and `option` is not None, then it defaults to the class `CONF_SECTION` attribute. option: ConfigurationKey Name of the configuration option whose value is reflected and affected by the action. register_shortcut: bool, optional If True, main window will expose the shortcut in Preferences. The default value is `False`. parent: QWidget (None) Define the parent of the widget. Use `self` if not provided. register_action: bool, optional If True, the action will be registered and searchable. The default value is `True`. overwrite: bool, optional If True, in case of action overwriting no warning will be shown. The default value is `False` context_name: Optional[str] Name of the context that holds the action in case of registration. The combination of `name` and `context_name` is unique so trying to register an action with the same `name` and `context_name` will cause a warning unless `overwrite` is set to `True`. menurole: QAction.MenuRole, optional Menu role for the action (it only has effect on macOS). Notes ----- There is no need to set shortcuts right now. We only create actions with this (and similar methods) and these are then exposed as possible shortcuts on plugin registration in the main window with the register_shortcut argument. If icon_text is True, this will also disable the tooltip. If a shortcut is found in the default config then it is assigned, otherwise it's left blank for the user to define one for it. Nz8Action must provide the toggled or triggered parameters!cdSrrrs rr z1SpyderActionMixin.create_action..r!r")r#r%r&r'r(r:r+r,r-r.r/register_action overwritemenurolez3Initial values can only apply to togglable actions!)r r1r2rr3r4r5 setIconTextboolr*shortcut_contextregister_shortcutr&r7rr6)r8r5r#r% icon_textr&r'r(rr:initialrr+r,rirrr/ractionrs rrzSpyderActionMixin.create_action`sL   J  >F  )8G,, )((G  6#5+ #%1%9!!|+!   $  *   y ) ) )"&y//"2#4    K!!'**** K$IKKK K -&6+= HWf55E%%e,,, r"r5r:r.r;cZ||jn|}||jn|}tj|||S)a Return an action by name, context and plugin. Parameters ---------- name: str Name of the action to retrieve. context: Optional[str] Widget or context identifier under which the action was stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the action was defined. If None, then `PLUGIN_NAME` is used. Returns ------- action: SpyderAction The corresponding action stored under the given `name`, `context` and `plugin`. Raises ------ KeyError If either of `name`, `context` or `plugin` keys do not exist in the action registry. )r3r4rr=r>s rryzSpyderActionMixin.get_actions;8&,^!!'.$##G,T67CCCr"cX||jn|}||jn|}tj||S)a Return all actions defined by a context on a given plugin. Parameters ---------- context: Optional[str] Widget or context identifier under which the actions were stored. If None, then `CONTEXT_NAME` is used instead plugin: Optional[str] Name of the plugin where the actions were defined. If None, then `PLUGIN_NAME` is used. Returns ------- actions: Dict[str, SpyderAction] A dictionary that maps string keys to their corresponding actions. Notes ----- 1. Actions should be created once. Creating new actions on menu popup is *highly* discouraged. 2. Actions can be created directly on a PluginMainWidget or PluginMainContainer subclass. Child widgets can also create actions, but they need to subclass SpyderWidgetMixin. 3. PluginMainWidget or PluginMainContainer will collect any actions defined in subwidgets (if defined) and expose them in the get_actions method at the plugin level. 4. Any action created this way is now exposed as a possible shortcut automatically without manual shortcut registration. If an option is found in the config system then it is assigned, otherwise it's left with an empty shortcut. 5. There is no need to override this method. )r3r4rrArBs r get_actionszSpyderActionMixin.get_actionss:F&,^!!'.$##G-fg>>>r"c td)z Update the state of exposed actions. Exposed actions are actions created by the `create_action` method. r|)NotImplementedError)r8optionss rupdate_actionsz SpyderActionMixin.update_actions&s ""%%%r"rD)rErFrGrHr{rWidgetWithChildrenShortcutrrIrrrydictrrrr"rrvrvEs !!!(.2RT"dT ;T(-tD!45#'$ |||||>B+/DDsDXc]D#C=D47DDDDB48,0%?%?8C=%?$SM%?59%?%?%?%?N&&&&&r"rvcNeZdZdZdZdZdfd ZedZdZ dZ xZ S)SpyderWidgetMixinag Basic functionality for all Spyder widgets and Qt items. This mixin does not include toolbar handling as that is limited to the application with the coreui plugin or the PluginMainWidget for dockable plugins. This provides a simple management of widget options, as well as Qt helpers for defining the actions a widget provides. Nc dD]B}t||d/t||rt||t||CtdS)N)r2r3)getattrhasattrsetattrsuper__init__)r8 class_parentattr __class__s rrzSpyderWidgetMixin.__init__Csr3 E EDtT4((0<..ED$ d(C(CDDD r"c*tj|S)zG Create an icon by name using the spyder Icon manager. )rr%)r5s r create_iconzSpyderWidgetMixin.create_iconLs x~~r"cdS)z Update stylesheet and style of the widget. This method will be called recursively on all widgets on theme change. Nrr8s r update_stylezSpyderWidgetMixin.update_styleSs r"cdS)z Update localization of the widget. This method will be called recursively on all widgets on language change. Nrrs rupdate_translationz$SpyderWidgetMixin.update_translation[s  r"r) rErFrGrHr3r4r staticmethodrrr __classcell__)rs@rrr/s  KL\           r"rN)#rHtypingrrr qtpy.QtCorerqtpy.QtWidgetsrrr r spyder.api.config.mixinsr spyder.api.exceptionsr rlrspyder.config.managerrspyder.utils.icon_managerrspyder.utils.qthelpersrrspyder.utils.registriesrrrrrrKrarvrrr"rrs5 '&&&&&&&&&FFFFFFFFFFFFA@@@@@000000//////&&&&&&))))))CCCCCCCCKKKKKKKKKKKKcCcCcCcCcCcCcCcCLW@W@W@W@W@W@W@W@tb=b=b=b=b=b=b=b=Jg&g&g&g&g&g&g&g&T3 3 3 3 3 )?35J3 3 3 3 3 r"