eric6/Documentation/Source/eric6.UI.UserInterface.html

changeset 7989
a21d673a8f99
parent 7960
e8fc383322f7
child 8049
af58c1d47e5e
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
135 135
136 <p> 136 <p>
137 Private method returning number of characters to write. 137 Private method returning number of characters to write.
138 </p> 138 </p>
139 <dl> 139 <dl>
140 <dt>Returns:</dt> 140 <dt>Return:</dt>
141 <dd> 141 <dd>
142 number of characters buffered or length of buffered line 142 number of characters buffered or length of buffered line
143 (integer) 143 (integer)
144 </dd> 144 </dd>
145 </dl> 145 </dl>
1434 <dd> 1434 <dd>
1435 reference to the started web browser process 1435 reference to the started web browser process
1436 </dd> 1436 </dd>
1437 </dl> 1437 </dl>
1438 <dl> 1438 <dl>
1439 <dt>Returns:</dt> 1439 <dt>Return:</dt>
1440 <dd> 1440 <dd>
1441 error indication (1 = connection not possible, 0 = ok, 1441 error indication (1 = connection not possible, 0 = ok,
1442 -1 = server exited with an error code) 1442 -1 = server exited with an error code)
1443 </dd> 1443 </dd>
1444 </dl> 1444 </dl>
1461 <dd> 1461 <dd>
1462 object name of the new dock window (string) 1462 object name of the new dock window (string)
1463 </dd> 1463 </dd>
1464 </dl> 1464 </dl>
1465 <dl> 1465 <dl>
1466 <dt>Returns:</dt> 1466 <dt>Return:</dt>
1467 <dd> 1467 <dd>
1468 the generated dock window (QDockWindow) 1468 the generated dock window (QDockWindow)
1469 </dd> 1469 </dd>
1470 </dl> 1470 </dl>
1471 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a> 1471 <a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
1635 <dd> 1635 <dd>
1636 reference to the widget to be saved (QWidget) 1636 reference to the widget to be saved (QWidget)
1637 </dd> 1637 </dd>
1638 </dl> 1638 </dl>
1639 <dl> 1639 <dl>
1640 <dt>Returns:</dt> 1640 <dt>Return:</dt>
1641 <dd> 1641 <dd>
1642 list giving the widget's geometry and its visibility 1642 list giving the widget's geometry and its visibility
1643 </dd> 1643 </dd>
1644 </dl> 1644 </dl>
1645 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a> 1645 <a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a>
1648 1648
1649 <p> 1649 <p>
1650 Private method to check, if an error log file exists. 1650 Private method to check, if an error log file exists.
1651 </p> 1651 </p>
1652 <dl> 1652 <dl>
1653 <dt>Returns:</dt> 1653 <dt>Return:</dt>
1654 <dd> 1654 <dd>
1655 flag indicating the existence of an error log file (boolean) 1655 flag indicating the existence of an error log file (boolean)
1656 </dd> 1656 </dd>
1657 </dl> 1657 </dl>
1658 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a> 1658 <a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
1809 <dd> 1809 <dd>
1810 word to search for 1810 word to search for
1811 </dd> 1811 </dd>
1812 </dl> 1812 </dl>
1813 <dl> 1813 <dl>
1814 <dt>Returns:</dt> 1814 <dt>Return:</dt>
1815 <dd> 1815 <dd>
1816 flag indicating a successful launch 1816 flag indicating a successful launch
1817 </dd> 1817 </dd>
1818 </dl> 1818 </dl>
1819 <dl> 1819 <dl>
1997 1997
1998 <p> 1998 <p>
1999 Private method to check for and read a crash session. 1999 Private method to check for and read a crash session.
2000 </p> 2000 </p>
2001 <dl> 2001 <dl>
2002 <dt>Returns:</dt> 2002 <dt>Return:</dt>
2003 <dd> 2003 <dd>
2004 flag indicating a crash session file was found and read 2004 flag indicating a crash session file was found and read
2005 </dd> 2005 </dd>
2006 </dl> 2006 </dl>
2007 <dl> 2007 <dl>
2023 <dd> 2023 <dd>
2024 name of a session file to read 2024 name of a session file to read
2025 </dd> 2025 </dd>
2026 </dl> 2026 </dl>
2027 <dl> 2027 <dl>
2028 <dt>Returns:</dt> 2028 <dt>Return:</dt>
2029 <dd> 2029 <dd>
2030 flag indicating success 2030 flag indicating success
2031 </dd> 2031 </dd>
2032 </dl> 2032 </dl>
2033 <dl> 2033 <dl>
2424 2424
2425 <p> 2425 <p>
2426 Private method to perform all necessary steps to close down the IDE. 2426 Private method to perform all necessary steps to close down the IDE.
2427 </p> 2427 </p>
2428 <dl> 2428 <dl>
2429 <dt>Returns:</dt> 2429 <dt>Return:</dt>
2430 <dd> 2430 <dd>
2431 flag indicating success 2431 flag indicating success
2432 </dd> 2432 </dd>
2433 </dl> 2433 </dl>
2434 <a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a> 2434 <a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a>
2547 <dd> 2547 <dd>
2548 reference to the workspace editor window 2548 reference to the workspace editor window
2549 </dd> 2549 </dd>
2550 </dl> 2550 </dl>
2551 <dl> 2551 <dl>
2552 <dt>Returns:</dt> 2552 <dt>Return:</dt>
2553 <dd> 2553 <dd>
2554 flag indicating, if the window was shown (boolean) 2554 flag indicating, if the window was shown (boolean)
2555 </dd> 2555 </dd>
2556 </dl> 2556 </dl>
2557 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a> 2557 <a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
2733 <dd> 2733 <dd>
2734 version string 2734 version string
2735 </dd> 2735 </dd>
2736 </dl> 2736 </dl>
2737 <dl> 2737 <dl>
2738 <dt>Returns:</dt> 2738 <dt>Return:</dt>
2739 <dd> 2739 <dd>
2740 version tuple 2740 version tuple
2741 </dd> 2741 </dd>
2742 </dl> 2742 </dl>
2743 <dl> 2743 <dl>
2827 <dd> 2827 <dd>
2828 flag indicating to write a crash session file 2828 flag indicating to write a crash session file
2829 </dd> 2829 </dd>
2830 </dl> 2830 </dl>
2831 <dl> 2831 <dl>
2832 <dt>Returns:</dt> 2832 <dt>Return:</dt>
2833 <dd> 2833 <dd>
2834 flag indicating success 2834 flag indicating success
2835 </dd> 2835 </dd>
2836 </dl> 2836 </dl>
2837 <dl> 2837 <dl>
3010 3010
3011 <p> 3011 <p>
3012 Public method to create the toolbars menu for Qt. 3012 Public method to create the toolbars menu for Qt.
3013 </p> 3013 </p>
3014 <dl> 3014 <dl>
3015 <dt>Returns:</dt> 3015 <dt>Return:</dt>
3016 <dd> 3016 <dd>
3017 toolbars menu (QMenu) 3017 toolbars menu (QMenu)
3018 </dd> 3018 </dd>
3019 </dl> 3019 </dl>
3020 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a> 3020 <a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a>
3023 3023
3024 <p> 3024 <p>
3025 Public method to provide a reference to the code documentation viewer. 3025 Public method to provide a reference to the code documentation viewer.
3026 </p> 3026 </p>
3027 <dl> 3027 <dl>
3028 <dt>Returns:</dt> 3028 <dt>Return:</dt>
3029 <dd> 3029 <dd>
3030 reference to the code documentation viewer 3030 reference to the code documentation viewer
3031 </dd> 3031 </dd>
3032 </dl> 3032 </dl>
3033 <dl> 3033 <dl>
3106 string denoting the action set to get. 3106 string denoting the action set to get.
3107 It must be one of "ui" or "wizards". 3107 It must be one of "ui" or "wizards".
3108 </dd> 3108 </dd>
3109 </dl> 3109 </dl>
3110 <dl> 3110 <dl>
3111 <dt>Returns:</dt> 3111 <dt>Return:</dt>
3112 <dd> 3112 <dd>
3113 list of all actions (list of E5Action) 3113 list of all actions (list of E5Action)
3114 </dd> 3114 </dd>
3115 </dl> 3115 </dl>
3116 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a> 3116 <a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
3119 3119
3120 <p> 3120 <p>
3121 Public method to get the current layout type. 3121 Public method to get the current layout type.
3122 </p> 3122 </p>
3123 <dl> 3123 <dl>
3124 <dt>Returns:</dt> 3124 <dt>Return:</dt>
3125 <dd> 3125 <dd>
3126 current layout type 3126 current layout type
3127 </dd> 3127 </dd>
3128 </dl> 3128 </dl>
3129 <dl> 3129 <dl>
3138 3138
3139 <p> 3139 <p>
3140 Public method to get the locale of the IDE. 3140 Public method to get the locale of the IDE.
3141 </p> 3141 </p>
3142 <dl> 3142 <dl>
3143 <dt>Returns:</dt> 3143 <dt>Return:</dt>
3144 <dd> 3144 <dd>
3145 locale of the IDE (string or None) 3145 locale of the IDE (string or None)
3146 </dd> 3146 </dd>
3147 </dl> 3147 </dl>
3148 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a> 3148 <a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
3158 <dd> 3158 <dd>
3159 name of the menu (string) 3159 name of the menu (string)
3160 </dd> 3160 </dd>
3161 </dl> 3161 </dl>
3162 <dl> 3162 <dl>
3163 <dt>Returns:</dt> 3163 <dt>Return:</dt>
3164 <dd> 3164 <dd>
3165 reference to the menu (QMenu) 3165 reference to the menu (QMenu)
3166 </dd> 3166 </dd>
3167 </dl> 3167 </dl>
3168 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a> 3168 <a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
3183 object name of the action to search for 3183 object name of the action to search for
3184 (string) 3184 (string)
3185 </dd> 3185 </dd>
3186 </dl> 3186 </dl>
3187 <dl> 3187 <dl>
3188 <dt>Returns:</dt> 3188 <dt>Return:</dt>
3189 <dd> 3189 <dd>
3190 reference to the menu action (QAction) 3190 reference to the menu action (QAction)
3191 </dd> 3191 </dd>
3192 </dl> 3192 </dl>
3193 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a> 3193 <a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
3203 <dd> 3203 <dd>
3204 name of the menu to search in (string) 3204 name of the menu to search in (string)
3205 </dd> 3205 </dd>
3206 </dl> 3206 </dl>
3207 <dl> 3207 <dl>
3208 <dt>Returns:</dt> 3208 <dt>Return:</dt>
3209 <dd> 3209 <dd>
3210 reference to the menu bar action (QAction) 3210 reference to the menu bar action (QAction)
3211 </dd> 3211 </dd>
3212 </dl> 3212 </dl>
3213 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a> 3213 <a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a>
3217 <p> 3217 <p>
3218 Public method to get the original PATH environment variable 3218 Public method to get the original PATH environment variable
3219 (i.e. before modifications by eric and PyQt5). 3219 (i.e. before modifications by eric and PyQt5).
3220 </p> 3220 </p>
3221 <dl> 3221 <dl>
3222 <dt>Returns:</dt> 3222 <dt>Return:</dt>
3223 <dd> 3223 <dd>
3224 original PATH environment variable 3224 original PATH environment variable
3225 </dd> 3225 </dd>
3226 </dl> 3226 </dl>
3227 <dl> 3227 <dl>
3236 3236
3237 <p> 3237 <p>
3238 Public method to get the toolbar icon size. 3238 Public method to get the toolbar icon size.
3239 </p> 3239 </p>
3240 <dl> 3240 <dl>
3241 <dt>Returns:</dt> 3241 <dt>Return:</dt>
3242 <dd> 3242 <dd>
3243 toolbar icon size (QSize) 3243 toolbar icon size (QSize)
3244 </dd> 3244 </dd>
3245 </dl> 3245 </dl>
3246 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a> 3246 <a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
3256 <dd> 3256 <dd>
3257 name of the toolbar (string) 3257 name of the toolbar (string)
3258 </dd> 3258 </dd>
3259 </dl> 3259 </dl>
3260 <dl> 3260 <dl>
3261 <dt>Returns:</dt> 3261 <dt>Return:</dt>
3262 <dd> 3262 <dd>
3263 reference to the toolbar entry (tuple of string and QToolBar) 3263 reference to the toolbar entry (tuple of string and QToolBar)
3264 </dd> 3264 </dd>
3265 </dl> 3265 </dl>
3266 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a> 3266 <a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a>
3277 <dd> 3277 <dd>
3278 toolbar category 3278 toolbar category
3279 </dd> 3279 </dd>
3280 </dl> 3280 </dl>
3281 <dl> 3281 <dl>
3282 <dt>Returns:</dt> 3282 <dt>Return:</dt>
3283 <dd> 3283 <dd>
3284 list of toolbars 3284 list of toolbars
3285 </dd> 3285 </dd>
3286 </dl> 3286 </dl>
3287 <dl> 3287 <dl>
3296 3296
3297 <p> 3297 <p>
3298 Public method to get the current view profile. 3298 Public method to get the current view profile.
3299 </p> 3299 </p>
3300 <dl> 3300 <dl>
3301 <dt>Returns:</dt> 3301 <dt>Return:</dt>
3302 <dd> 3302 <dd>
3303 the name of the current view profile (string) 3303 the name of the current view profile (string)
3304 </dd> 3304 </dd>
3305 </dl> 3305 </dl>
3306 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a> 3306 <a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
3345 3345
3346 <p> 3346 <p>
3347 Public method to get a reference to the network access manager object. 3347 Public method to get a reference to the network access manager object.
3348 </p> 3348 </p>
3349 <dl> 3349 <dl>
3350 <dt>Returns:</dt> 3350 <dt>Return:</dt>
3351 <dd> 3351 <dd>
3352 reference to the network access manager object 3352 reference to the network access manager object
3353 </dd> 3353 </dd>
3354 </dl> 3354 </dl>
3355 <dl> 3355 <dl>
3716 <dd> 3716 <dd>
3717 required snapshot version (string) 3717 required snapshot version (string)
3718 </dd> 3718 </dd>
3719 </dl> 3719 </dl>
3720 <dl> 3720 <dl>
3721 <dt>Returns:</dt> 3721 <dt>Return:</dt>
3722 <dd> 3722 <dd>
3723 flag indicating, that the version is newer than the required 3723 flag indicating, that the version is newer than the required
3724 one (boolean) 3724 one (boolean)
3725 </dd> 3725 </dd>
3726 </dl> 3726 </dl>

eric ide

mercurial