diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100755 index 0000000..2c8b8ad --- /dev/null +++ b/404.html @@ -0,0 +1,377 @@ + + + +
+ + + + + + + + + + + + + + + + +
+ Bases: Frame
Editor class +Picks the right editor based on the path, path2, diff values passed. Supports showing diff, images, text files. +If nothing is passed, empty text editor is opened.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
path |
+
+ str
+ |
+
+
+
+ path of the file to be opened + |
+
+ None
+ |
+
path2 |
+
+ str
+ |
+
+
+
+ path of file to be opened in diff, required if diff=True is passed + |
+
+ None
+ |
+
diff |
+
+ bool
+ |
+
+
+
+ whether this is to be opened in diff editor + |
+
+ False
+ |
+
language |
+
+ str
+ |
+
+
+
+ Use the |
+
+ None
+ |
+
dark_mode |
+ + | +
+
+
+ Sets the editor theme to cupcake dark if True, or cupcake light by default +This is ignored if custom config_file path is passed + |
+ + required + | +
config_file |
+
+ str
+ |
+
+
+
+ path to the custom config (TOML) file, uses theme defaults if not passed + |
+
+ None
+ |
+
showpath |
+
+ bool
+ |
+
+
+
+ whether to show the breadcrumbs for editor or not + |
+
+ True
+ |
+
font |
+
+ str | Font
+ |
+
+
+
+ Font used in line numbers, text editor, autocomplete. defaults to Consolas(11) + |
+
+ None
+ |
+
uifont |
+
+ str | Font
+ |
+
+
+
+ Font used for other UI components (breadcrumbs, trees) + |
+
+ None
+ |
+
preview_file_callback |
+
+ Callable
+ |
+
+
+
+ called when files in breadcrumbs-pathview are single clicked. MUST take an argument (path) + |
+
+ None
+ |
+
open_file_callback |
+
+ Callable
+ |
+
+
+
+ called when files in breadcrumbs-pathview are double clicked. MUST take an argument (path) + |
+
+ None
+ |
+
NOTE: All the standard tk.Text methods and properties are available under Editor.content (eg. Editor.content.insert, Editor.content.get)
+ + +Methods:
+Name | +Description | +
---|---|
save |
+
+
+
+ If the content is editable writes to the specified path. + |
+
focus |
+
+
+
+ Gives focus to the content. + |
+
cupcake\__init__.py
44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 |
|
focus()
+
+save(path=None)
+
+Saves the content to the specified path
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
path |
+
+ str
+ |
+
+
+
+ path to save the content. Defaults to None. + |
+
+ None
+ |
+
+ Bases: BaseEditor
DiffEditor class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
path1 |
+
+ str
+ |
+
+
+
+ Path to the first file. + |
+ + required + | +
path2 |
+
+ str
+ |
+
+
+
+ Path to the second file. + |
+ + required + | +
language |
+ + | +
+
+
+ Language to use for syntax highlighting. + |
+
+ None
+ |
+
cupcake\diffeditor\__init__.py
9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 |
|
run_show_diff()
+
+show_diff()
+
+Show the diff between the two files.
+ +cupcake\diffeditor\__init__.py
109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 |
|
show_diff_text(lhs, rhs)
+
+Show the diff between the two texts.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
lhs |
+
+ str
+ |
+
+
+
+ The left-hand side text. + |
+ + required + | +
rhs |
+
+ str
+ |
+
+
+
+ The right-hand side text. + |
+ + required + | +
cupcake\diffeditor\__init__.py
Config class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
config_file |
+ + | +
+
+
+ Path to the config file. + |
+
+ ''
+ |
+
darkmode |
+ + | +
+
+
+ Whether to use dark mode. + |
+
+ True
+ |
+
font |
+ + | +
+
+
+ Font to use for the text. + |
+
+ ''
+ |
+
uifont |
+ + | +
+
+
+ Font to use for the UI. + |
+
+ ''
+ |
+
Attributes:
+Name | +Type | +Description | +
---|---|---|
base |
+ + | +
+
+
+ Parent widget. + |
+
dir |
+ + | +
+
+
+ Directory of the module. + |
+
stipple |
+ + | +
+
+
+ Path to the stipple file. + |
+
font |
+ + | +
+
+
+ Font to use for the text. + |
+
uifont |
+ + | +
+
+
+ Font to use for the UI. + |
+
theme |
+ + | +
+
+
+ SimpleNamespace object containing the theme settings. + |
+
syntax |
+ + | +
+
+
+ Syntax settings. + |
+
style |
+ + | +
+
+
+ Style + |
+
cupcake\config\__init__.py
Holds all available languages. To be passed to Editor during initialization.
+ +cupcake\languages.py
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 +306 +307 +308 +309 +310 +311 +312 +313 +314 +315 +316 +317 +318 +319 +320 +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354 +355 +356 +357 +358 +359 +360 +361 +362 +363 +364 +365 +366 +367 +368 +369 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +383 +384 +385 +386 +387 +388 +389 +390 +391 +392 +393 +394 +395 +396 +397 +398 +399 +400 +401 +402 +403 +404 +405 +406 +407 +408 +409 +410 +411 +412 +413 +414 +415 +416 +417 +418 +419 +420 +421 +422 +423 +424 +425 +426 +427 +428 +429 +430 +431 +432 +433 +434 +435 +436 +437 +438 +439 +440 +441 +442 +443 +444 +445 +446 +447 +448 +449 +450 +451 +452 +453 +454 +455 +456 +457 +458 +459 +460 +461 +462 +463 +464 +465 +466 +467 +468 +469 +470 +471 +472 +473 +474 +475 +476 +477 +478 +479 +480 +481 +482 +483 +484 +485 +486 +487 +488 +489 +490 +491 +492 +493 +494 +495 +496 +497 +498 +499 +500 +501 +502 +503 +504 +505 +506 +507 +508 +509 +510 +511 +512 +513 +514 +515 +516 +517 +518 +519 +520 +521 +522 +523 +524 +525 +526 +527 +528 +529 +530 +531 +532 +533 +534 +535 +536 +537 +538 +539 +540 +541 +542 +543 +544 +545 +546 +547 +548 +549 +550 +551 +552 +553 +554 |
|
+ Bases: BaseEditor
ImageViewer class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
path |
+
+ str
+ |
+
+
+
+ Path to the image file. + |
+ + required + | +
cupcake\imageviewer\__init__.py
open_image()
+
+Opens the image file.
+ +cupcake\imageviewer\__init__.py
+ Bases: BaseEditor
TextEditor class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
path |
+ + | +
+
+
+ Path to the file. + |
+
+ ''
+ |
+
language |
+ + | +
+
+
+ Language to use for syntax highlighting. + |
+
+ ''
+ |
+
font |
+ + | +
+
+
+ Font to use for the text. + |
+
+ ''
+ |
+
minimalist |
+ + | +
+
+
+ Whether to use the minimalist mode. + |
+
+ False
+ |
+
cupcake\texteditor\__init__.py
11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 |
|
+ Bases: Frame
BreadCrumbs class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
path |
+ + | +
+
+
+ Path to the file. + |
+
+ ''
+ |
+
Attributes:
+Name | +Type | +Description | +
---|---|---|
pathview |
+ + | +
+
+
+ PathView object. + |
+
cupcake\breadcrumbs\__init__.py
additem(path, text)
+
+Adds an item to the breadcrumbs.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
path |
+
+ str
+ |
+
+
+
+ Path to the item. + |
+ + required + | +
text |
+
+ str
+ |
+
+
+
+ Text to display. + |
+ + required + | +
cupcake\breadcrumbs\__init__.py
+ Bases: Toplevel
PathView class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
width |
+ + | +
+
+
+ Width of the path view. + |
+
+ 150
+ |
+
cupcake\breadcrumbs\pathview.py
get_popup_x(width)
+
+Returns the x position for the popup.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
width |
+ + | +
+
+
+ Width of the popup. + |
+ + required + | +
Returns:
+Name | Type | +Description | +
---|---|---|
int | + | +
+
+
+ X position. + |
+
cupcake\breadcrumbs\pathview.py
get_popup_y()
+
+Returns the y position for the popup.
+ + +Returns:
+Name | Type | +Description | +
---|---|---|
int | + | +
+
+
+ Y position. + |
+
hide(*_)
+
+show(e)
+
+Shows the path view.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
e |
+
+ Event
+ |
+
+
+
+ Event object. + |
+ + required + | +
cupcake\breadcrumbs\pathview.py
+ Bases: Canvas
cupcake\texteditor\linenumbers\__init__.py
get_indentation_level(line)
+
+
+ Bases: Toplevel
AutoComplete class.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
master |
+ + | +
+
+
+ Parent widget. + |
+ + required + | +
items |
+ + | +
+
+
+ List of items to autocomplete. + |
+
+ None
+ |
+
active |
+ + | +
+
+
+ Whether the autocomplete is active. + |
+
+ False
+ |
+
cupcake\texteditor\autocomplete\__init__.py
9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 |
|
add_all_items()
+
+Adds all items to the menu.
+ + +add_item(text, kind='')
+
+Adds an item to the menu.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
text |
+
+ str
+ |
+
+
+
+ Text to add. + |
+ + required + | +
kind |
+ + | +
+
+
+ Kind of the item. + |
+
+ ''
+ |
+
cupcake\texteditor\autocomplete\__init__.py
choose(this=None, *_)
+
+Chooses an item.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
this |
+ + | +
+
+
+ The item to choose. Used when user clicks on an item. + |
+
+ None
+ |
+
cupcake\texteditor\autocomplete\__init__.py
get_items_text()
+
+Gets the text of all items.
+ + +Returns:
+Type | +Description | +
---|---|
+ | +
+
+
+ List of text of all items. + |
+
hide(*_)
+
+hide_all_items()
+
+move_down(*_)
+
+move_up(*_)
+
+refresh_geometry(*_)
+
+Refreshes the geometry of the menu.
+ + +refresh_selected()
+
+Refreshes the selected item.
+ +cupcake\texteditor\autocomplete\__init__.py
remove_item(item)
+
+Removes an item from the menu.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
item |
+
+ AutoCompleteItem
+ |
+
+
+
+ Item to remove. + |
+ + required + | +
cupcake\texteditor\autocomplete\__init__.py
reset()
+
+reset_selection()
+
+select(delta)
+
+Selects an item.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
delta |
+
+ int
+ |
+
+
+
+ The change in selection. + |
+ + required + | +
cupcake\texteditor\autocomplete\__init__.py
show(pos)
+
+Shows the menu.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
pos |
+
+ tuple[int, int]
+ |
+
+
+
+ Position to show the menu. + |
+ + required + | +
cupcake\texteditor\autocomplete\__init__.py
show_items(items, term)
+
+Shows the items.
+ + +Parameters:
+Name | +Type | +Description | +Default | +
---|---|---|---|
items |
+
+ list[AutoCompleteItem]
+ |
+
+
+
+ Items to show. + |
+ + required + | +
term |
+
+ str
+ |
+
+
+
+ The term to match. + |
+ + required + | +
cupcake\texteditor\autocomplete\__init__.py
update_all_words()
+
+Updates the words in the menu.
+ +cupcake\texteditor\autocomplete\__init__.py
update_completions()
+
+Updates and rerenders the completions.
+ +cupcake\texteditor\autocomplete\__init__.py