,]c@sdZddlZddlZddlmZddlmZmZmZm Z m Z ddl m Z m Z ddlmZmZmZmZmZmZmZddlmZddlmZmZdd lmZdd lmZdd lm Z m!Z!dd l"m#Z$dd l%m&Z&m'Z'defdYZ(defdYZ)de*fdYZ+dee+fdYZ,dS(s spyder.plugins ============== Here, 'plugins' are widgets designed specifically for Spyder These plugins inherit the following classes (SpyderPluginMixin & SpyderPluginWidget) iN(tPYQT5(tQEventtQObjecttQPointtQttSignal(tQCursort QKeySequence(t QApplicationt QDockWidgett QMainWindowt QShortcuttQTabBartQWidgett QMessageBox(t_(tget_color_schemetget_font(tCONF(t NoDefault(t configparsertis_text_string(t icon_manager(t create_actionttoggle_actionst TabFiltercBsqeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z RS( s Filter event attached to each QTabBar that holds 2 or more dockwidgets in charge of handling tab rearangement. This filter also holds the methods needed for the detection of a drag and the movement of tabs. cCs>tj|||_||_t|_d|_d|_dS(N( Rt__init__t dock_tabbartmaintFalsetmovingtNonet from_indextto_index(tselfRR((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR2s      cCsOxH|jjD]:}|jj|jdd}|j|kr |Sq WdS(s(Get plugin reference based on tab index.t&tN(Rt widgetlistRttabTexttreplacetget_plugin_title(R"tindextpluginttab_text((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt _get_plugin;scCsFg}x9t|jjD]"}|j|}|j|qW|S(st Get a list of all plugin references in the QTabBar to which this event filter is attached. (trangeRtcountR,tappend(R"tpluginsR)R*((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt _get_pluginsBs cCst||||}|jj|j}|jj|j}||}|jj||j}||}|dkr||}nd}t} |jj| j} | j| j} } | |ks| |kr|jj t | || } | j | ndS(s<Fix mouse cursor position to adjust for different tab sizes.iN( tabsRttabRecttwidthtxRt mapFromGlobaltpostyt mapToGlobalRtsetPos(R"R R!t directiont tab_widtht tab_x_mint tab_x_maxtprevious_widthtdeltatcursorR7R5R8tnew_pos((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt _fix_cursorMs     cCs|j}|tjkr,|j|tS|tjkrdy|j|Wntk r_nXtS|tj kr|j |tStS(sFilter mouse press events. Events that are captured and not propagated return True. Events that are not captured and are propagated return False. ( ttypeRtMouseButtonPresst tab_pressedRt MouseMovet tab_movedt TypeErrortTruetMouseButtonReleaset tab_released(R"tobjteventt event_type((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt eventFiltercs    cCsv|jj|j|_|jj|j|jtjkrr|jdkrb|j|qr|j |ndS(s9Method called when a tab from a QTabBar has been pressed.iN( RttabAtR7R tsetCurrentIndextbuttonRt RightButtontshow_nontab_menut show_tab_menu(R"RN((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRFxs cCs|jtj@s d|_dS|jj|j|_|j r|j dkr|jdkrt j tj t |_n|jdkr|j |_n|j |j}}||ddfkr|j|||j||||_ ndS(s7Method called when a tab from a QTabBar has been moved.Ni(iN(tbuttonsRt LeftButtonRR!RRQR7RR RtsetOverrideCursortClosedHandCursorRJtmove_tabRC(R"RNR R!((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRHs ( cCstjt|_dS(s:Method called when a tab from a QTabBar has been released.N(RtrestoreOverrideCursorRR(R"RN((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRLs c Cs|j}|j|}|j|}|j|}|j|}||||||<|||jj|jn|jdk rc|jj|jn|j dk r|j j|j n|j |j dS(s6Initialize plugin: connect signals, setup actions, ...N( tcreate_toggle_view_actiontget_plugin_actionsRt show_messageRRpt _SpyderPluginMixin__show_messagetupdate_plugin_titlet'_SpyderPluginMixin__update_plugin_titletsig_option_changedt set_optiontsetWindowTitleR((R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytinitialize_plugins cCs tdS(s3Action to be performed on first plugin registrationN(tNotImplementedError(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyton_first_registration'scCsL|jdtrHy|jWntk r4dSX|jdtndS(s~If this is the first time the plugin is shown, perform actions to initialize plugin position in Spyder's window layoutt first_timeN(t get_optionRJRRRR(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt&initialize_plugin_in_mainwindow_layout0s  cCs||j}|jdkr-|j|_ntjddrhtjdd}|j|gdn|j|jdS(NRtuse_custom_margint custom_margini(tlayoutRRtgetContentsMarginsRRtsetContentsMargins(R"Rtmargin((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytupdate_margins:s cCsQ|jdk r|j}n|jdk r6|j}ndS|j|jdS(s8Update plugin title, i.e. dockwidget or mainwindow titleN(R_RRRR((R"twin((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt__update_plugin_titleDs   cCst|j|j}|j|jjd|j|j|j|j |j ||j |j j |j|jj |j||_|jdk rtt|j|j|j}|j|dd|jn||jfS(s*Add to parent QMainWindow as a dock widgett_dwRs Switch to %sN(RlR(Rt setObjectNameRRitsetAllowedAreast ALLOWED_AREASt setFeaturestFEATURESt setWidgetRRoRptvisibility_changedRsR_RRR Rtswitch_to_plugintregister_shortcutRtLOCATION(R"tdocktsc((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytcreate_dockwidgetNs     cCst|_}|jtj|j}t|rJ|j|}n|j||j |j |j ||j |S(sv Create a QMainWindow instance containing this plugin Note: this method is currently not used ( R Rt setAttributeRtWA_DeleteOnClosetget_plugin_iconRtget_icont setWindowIconRR(tsetCentralWidgettrefresh_plugin(R"Rticon((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytcreate_mainwindowis     cCs3|jdk r/|j||}|j|SdS(s+Create configuration dialog box page widgetN(tCONFIGWIDGET_CLASSRt initialize(R"Rrt configwidget((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytcreate_configwidgetys cCs tdS(s*Apply configuration file's plugin settingsN(R(R"toptions((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytapply_plugin_settingsscCs|jj||||dS(s Register QAction or QShortcut to Spyder main application if add_sc_to_tip is True, the shortcut is added to the action's tooltip N(RR(R"tqaction_or_qshortcuttcontexttnamet add_sc_to_tip((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRscCs7x0|jD]"\}}}|j|||q WdS(sr Register widget shortcuts widget interface must have a method called 'get_shortcut_data' N(tget_shortcut_dataR(R"twidgett qshortcutRR((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytregister_widget_shortcutsscCsv|jjdk rC|jjjrC|jj|k rC|jjn|jjse|jjtn|j tdS(sSwitch to plugin.N( Rt last_pluginRRtmaximize_dockwidgetRt isCheckedt setCheckedRJR(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRscCs|r;|jj|j}|dk r;|jq;n|jjpP|j}|jrot|j |n|ox||_ |j r|j ndS(s!DockWidget visibility has changedN( R_R`tget_focus_widgetRtsetFocust isVisibleRtDISABLE_ACTIONS_WHEN_HIDDENRRRR(R"tenableRtvisible((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRs     cCs|jjtdS(sDockWidget was closedN(RRR(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRsscCs tj|jt||dS(s Set a plugin option in configuration file Use a SIGNAL to call it, e.g.: plugin.sig_option_changed.emit('show_all', checked) N(RtsetRtstr(R"toptionRz((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRscCstj|j||S(s+Get a plugin option from configuration file(RRR(R"Rtdefault((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRscCs:|rd}|j}nd}|j}td|d|S(s Return plugin font option. All plugins in Spyder use a global font. This is a convenience method in case some plugins will have a delta size based on the default size. t rich_fonttfontRtfont_size_delta(tRICH_FONT_SIZE_DELTAtFONT_SIZE_DELTAR(R"t rich_textRR((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytget_plugin_fonts   cCstddS(s Set plugin font option. Note: All plugins in Spyder use a global font. To define a different size, the plugin must define a 'FONT_SIZE_DELTA' class variable. srPlugins font is based on the general settings, and cannot be set directly on the plugin.This method is deprecated.N(t Exception(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytset_plugin_fontscCsdS(sa This has to be reimplemented by plugins that need to adjust their fonts N((R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt update_fontscCs|jjj||dS(s(Show message in main window's status barN(Rt statusBart showMessage(R"tmessagettimeout((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyt__show_messagescCs1|j|tjttjtjdS(sp Showing message in main window's status bar and changing mouse cursor to Qt.WaitCursor N(RRRYRRt WaitCursort processEvents(R"R((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytstarting_long_processs R$cCs+tj|j|ddtjdS(sV Clearing main window's status bar and restoring mouse cursor RiN(RR\RR(R"R((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytending_long_processs cCsttjddS(sGet current color schemet color_schemestselected(RRR(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRsc sj}jdkr*td}njdk rrt|dfddtjdtj}nt|dfd}|_ dS( s/Associate a toggle view action with each pluginteditortEditorttoggledcs j|S(N(t toggle_view(tchecked(R"(s6lib/python2.7/site-packages/spyder/plugins/__init__.pytR$RRcs j|S(N(R(R(R"(s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRsN( R(RRRRRRRtWidgetShortcutR(R"Rntaction((R"s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRs  cCsA|js dS|r0|jj|jjn |jjdS(s Toggle viewN(R_tshowR`thide(R"R((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR s   N(3RiRjRkRRRRRtIMG_PATHRtAllDockWidgetAreasRtLeftDockWidgetAreaRR tDockWidgetClosabletDockWidgetFloatableRRJRRRRRRRRRRRRRRRRRRRRsRRRRRRRRRRRR(((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR~sN                  tSpyderPluginWidgetcBseZdZeeeZeeeZeZ e rEdZ n dZ dZ dZ dZedZdZdZd Zd Zd ZRS( sn Spyder base widget class Spyder's widgets either inherit this class or reimplement its interface cKsE|j\}}tt|j|||sA|j|ndS(N(tcheck_compatibilityRmRRtshow_compatibility_message(R"RrRRR((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR scCsL|j\}}tj||tj|||sH|j|ndS(N(RR RR~R(R"RrRR((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR&s cCs tdS(s Return plugin title Note: after some thinking, it appears that using a method is more flexible here than using a class attribute N(R(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR(-scCs tjdS(s Return plugin icon (QIcon instance) Note: this is required for plugins creating a main window (see SpyderPluginMixin.create_mainwindow) and for configuration dialog widgets creation toutline_explorer(timaR(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR5scCsdS(sq Return the widget to give focus to when this plugin's dockwidget is raised on top-level N((R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR>scCstS(s Perform actions before parent main window is closed Return True or False whether the plugin may be closed immediately or not Note: returned value is ignored if *cancelable* is False (RJ(R"t cancelable((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytclosing_pluginEscCs tdS(sRefresh widgetN(R(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRMscCs tdS(s Return a list of actions related to plugin Note: these actions will be enabled when plugin's dockwidget is visible and they will be disabled when it's hidden N(R(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRQscCs tdS(s'Register plugin in Spyder's main windowN(R(R"((s6lib/python2.7/site-packages/spyder/plugins/__init__.pytregister_pluginYscCsd}t}||fS(s This method can be implemented to check compatibility of a plugin for a given condition. `message` should give information in case of non compatibility: For example: 'This plugin does not work with Qt4' R$(RJ(R"Rtvalid((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyR]scCsdt|}|jtj|jtj|jd|j||jtj |j dS(sShow compatibility message.sCompatibility CheckN( RtsetWindowModalityRtNonModalRRRtsetTexttsetStandardButtonstOkR(R"Rt messageBox((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRis   (RiRjRkRRtobjectRtintRRRRR(RRRR RRR RR(((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyRs           (-RkRRtqtpyRt qtpy.QtCoreRRRRRt qtpy.QtGuiRRtqtpy.QtWidgetsRR R R R R Rtspyder.config.baseRtspyder.config.guiRRtspyder.config.mainRtspyder.config.userRtspyder.py3compatRRt spyder.utilsRRtspyder.utils.qthelpersRRRRlRR~R(((s6lib/python2.7/site-packages/spyder/plugins/__init__.pyts$  (4.2