From 0c4645241a69aa7a0831bf0f83b4b13bfc2d64bc Mon Sep 17 00:00:00 2001 From: RubicBG Date: Mon, 7 Oct 2024 21:03:12 +0300 Subject: [PATCH] docs --- docs/functions/color.html | 281 +++++++++++++++++------------------ docs/functions/enums.html | 245 ++++++++++++++++++++++++++++++ docs/functions/index.html | 147 ------------------ docs/functions/reg.html | 4 +- docs/functions/this.html | 23 +-- docs/functions/unsorted.html | 116 +++++++++++++++ docs/menu.json | 2 + 7 files changed, 519 insertions(+), 299 deletions(-) create mode 100644 docs/functions/enums.html create mode 100644 docs/functions/unsorted.html diff --git a/docs/functions/color.html b/docs/functions/color.html index d9fb2bb..2594a08 100644 --- a/docs/functions/color.html +++ b/docs/functions/color.html @@ -3,147 +3,146 @@

Color namespace contains predefined colors


-color.aliceblue
-color.antiquewhite
-color.aqua
-color.aquamarine
-color.azure
-color.beige
-color.bisque
-color.black
-color.blanchedalmond
-color.blue
-color.blueviolet
-color.brown
-color.burlywood
-color.cadetblue
-color.chartreuse
-color.chocolate
-color.coral
-color.cornflowerblue
-color.cornsilk
-color.crimson
-color.cyan
-color.darkblue
-color.darkcyan
-color.darkgoldenrod
-color.darkgray
-color.darkgreen
-color.darkkhaki
-color.darkmagenta
-color.darkolivegreen
-color.darkorange
-color.darkorchid
-color.darkred
-color.darksalmon
-color.darkseagreen
-color.darkslateblue
-color.darkslategray
-color.darkturquoise
-color.darkviolet
-color.deeppink
-color.deepskyblue
-color.dimgray
-color.dodgerblue
-color.firebrick
-color.floralwhite
-color.forestgreen
-color.fuchsia
-color.gainsboro
-color.ghostwhite
-color.gold
-color.goldenrod
-color.gray
-color.green
-color.greenyellow
-color.honeydew
-color.hotpink
-color.indianred
-color.indigo
-color.ivory
-color.khaki
-color.lavender
-color.lavenderblush
-color.lawngreen
-color.lemonchiffon
-color.lightblue
-color.lightcoral
-color.lightcyan
-color.lightgoldenrodyellow
-color.lightgray
-color.lightgreen
-color.lightpink
-color.lightsalmon
-color.lightseagreen
-color.lightskyblue
-color.lightslategray
-color.lightsteelblue
-color.lightyellow
-color.lime
-color.limegreen
-color.linen
-color.magenta
-color.maroon
-color.mediumaquamarine
-color.mediumblue
-color.mediumorchid
-color.mediumpurple
-color.mediumseagreen
-color.mediumslateblue
-color.mediumspringgreen
-color.mediumturquoise
-color.mediumvioletred
-color.midnightblue
-color.mintcream
-color.mistyrose
-color.moccasin
-color.navajowhite
-color.navy
-color.oldlace
-color.olive
-color.olivedrab
-color.orange
-color.orangered
-color.orchid
-color.palegoldenrod
-color.palegreen
-color.paleturquoise
-color.palevioletred
-color.papayawhip
-color.peachpuff
-color.peru
-color.pink
-color.plum
-color.powderblue
-color.purple
-color.red
-color.rosybrown
-color.royalblue
-color.saddlebrown
-color.salmon
-color.sandybrown
-color.seagreen
-color.seashell
-color.sienna
-color.silver
-color.skyblue
-color.slateblue
-color.slategray
-color.snow
-color.springgreen
-color.steelblue
-color.tan
-color.teal
-color.thistle
-color.tomato
-color.transparent
-color.turquoise
-color.violet
-color.wheat
-color.white
-color.whitesmoke
-color.yellow
-color.yellowgreen
+color.aliceblue              // #F0F8FF
+color.antiquewhite           // #FAEBD7
+color.aqua                   // #00FFFF
+color.aquamarine             // #7FFFD4
+color.azure                  // #F0FFFF
+color.beige                  // #F5F5DC
+color.bisque                 // #FFE4C4
+color.black                  // #000000
+color.blanchedalmond         // #FFEBCD
+color.blue                   // #0000FF
+color.blueviolet             // #8A2BE2
+color.brown                  // #A52A2A
+color.burlywood              // #DEB887
+color.cadetblue              // #5F9EA0
+color.chartreuse             // #7FFF00
+color.chocolate              // #D2691E
+color.coral                  // #FF7F50
+color.cornflowerblue         // #6495ED
+color.cornsilk               // #FFF8DC
+color.crimson                // #DC143C
+color.cyan                   // #00FFFF
+color.darkblue               // #00008B
+color.darkcyan               // #008B8B
+color.darkgoldenrod          // #B8860B
+color.darkgray               // #A9A9A9
+color.darkgreen              // #006400
+color.darkkhaki              // #BDB76B
+color.darkmagenta            // #8B008B
+color.darkolivegreen         // #556B2F
+color.darkorange             // #FF8C00
+color.darkorchid             // #9932CC
+color.darkred                // #8B0000
+color.darksalmon             // #E9967A
+color.darkseagreen           // #8FBC8F
+color.darkslateblue          // #483D8B
+color.darkslategray          // #2F4F4F
+color.darkturquoise          // #00CED1
+color.darkviolet             // #9400D3
+color.deeppink               // #FF1493
+color.deepskyblue            // #00BFFF
+color.dimgray                // #696969
+color.dodgerblue             // #1E90FF
+color.firebrick              // #B22222
+color.floralwhite            // #FFFAF0
+color.forestgreen            // #228B22
+color.fuchsia                // #FF00FF
+color.gainsboro              // #DCDCDC
+color.ghostwhite             // #F8F8FF
+color.gold                   // #FFD700
+color.goldenrod              // #DAA520
+color.gray                   // #808080
+color.green                  // #008000
+color.greenyellow            // #ADFF2F
+color.honeydew               // #F0FFF0
+color.hotpink                // #FF69B4
+color.indianred              // #CD5C5C
+color.indigo                 // #4B0082
+color.ivory                  // #FFFFF0
+color.khaki                  // #F0E68C
+color.lavender               // #E6E6FA
+color.lavenderblush          // #FFF0F5
+color.lawngreen              // #7CFC00
+color.lemonchiffon           // #FFFACD
+color.lightblue              // #ADD8E6
+color.lightcoral             // #F08080
+color.lightcyan              // #E0FFFF
+color.lightgoldenrodyellow   // #FAFAD2
+color.lightgray              // #D3D3D3
+color.lightgreen             // #90EE90
+color.lightpink              // #FFB6C1
+color.lightsalmon            // #FFA07A
+color.lightseagreen          // #20B2AA
+color.lightskyblue           // #87CEFA
+color.lightslategray         // #778899
+color.lightsteelblue         // #B0C4DE
+color.lightyellow            // #FFFFE0
+color.lime                   // #00FF00
+color.limegreen              // #32CD32
+color.linen                  // #FAF0E6
+color.magenta                // #FF00FF
+color.maroon                 // #800000
+color.mediumaquamarine       // #66CDAA
+color.mediumblue             // #0000CD
+color.mediumorchid           // #BA55D3
+color.mediumpurple           // #9370DB
+color.mediumseagreen         // #3CB371
+color.mediumslateblue        // #7B68EE
+color.mediumspringgreen      // #00FA9A
+color.mediumturquoise        // #48D1CC
+color.mediumvioletred        // #C71585
+color.midnightblue           // #191970
+color.mintcream              // #F5FFFA
+color.mistyrose              // #FFE4E1
+color.moccasin               // #FFE4B5
+color.navajowhite            // #FFDEAD
+color.navy                   // #000080
+color.oldlace                // #FDF5E6
+color.olive                  // #808000
+color.olivedrab              // #6B8E23
+color.orange                 // #FFA500
+color.orangered              // #FF4500
+color.orchid                 // #DA70D6
+color.palegoldenrod          // #EEE8AA
+color.palegreen              // #98FB98
+color.paleturquoise          // #AFEEEE
+color.palevioletred          // #DB7093
+color.papayawhip             // #FFEFD5
+color.peachpuff              // #FFDAB9
+color.peru                   // #CD853F
+color.pink                   // #FFC0CB
+color.plum                   // #DDA0DD
+color.powderblue             // #B0E0E6
+color.purple                 // #800080
+color.red                    // #FF0000
+color.rosybrown              // #BC8F8F
+color.royalblue              // #4169E1
+color.saddlebrown            // #8B4513
+color.salmon                 // #FA8072
+color.sandybrown             // #F4A460
+color.seagreen               // #2E8B57
+color.seashell               // #FFF5EE
+color.sienna                 // #A0522D
+color.silver                 // #C0C0C0
+color.skyblue                // #87CEEB
+color.slateblue              // #6A5ACD
+color.slategray              // #708090
+color.snow                   // #FFFAFA
+color.springgreen            // #00FF7F
+color.steelblue              // #4682B4
+color.tan                    // #D2B48C
+color.teal                   // #008080
+color.thistle                // #D8BFD8
+color.tomato                 // #FF6347
+color.turquoise              // #40E0D0
+color.violet                 // #EE82EE
+color.wheat                  // #F5DEB3
+color.white                  // #FFFFFF
+color.whitesmoke             // #F5F5F5
+color.yellow                 // #FFFF00
+color.yellowgreen            // #9ACD32
 

color.rgb(red, green, blue)
diff --git a/docs/functions/enums.html b/docs/functions/enums.html new file mode 100644 index 0000000..8b8cfd8 --- /dev/null +++ b/docs/functions/enums.html @@ -0,0 +1,245 @@ +

Enumerations

+ + + +
+
Key enumerations
+

Syntax

+
key.rbutton
+key.mbutton
+key.lbutton
+key.shift
+
+key.control
+key.ctrl
+key.win
+key.alt
+key.space
+key.capital
+key.capslock
+key.tab
+key.up
+key.down
+key.left
+
+key.right
+key.lshift
+key.lcontrol
+key.lctrl
+key.lwin
+key.lalt
+key.rshift
+key.rcontrol
+key.rctrl
+key.rwin
+key.ralt
+
+key.escape
+key.help
+
+key.f1
+key.f2
+key.f3
+key.f4
+key.f5
+key.f6
+key.f7
+key.f8
+key.f9
+key.f10
+key.f11
+key.f12
+
+key.print
+key.printscreen
+key.snapshot
+
+key.home
+key.end
+key.pageup
+key.pagedown
+key.insert
+key.delete
+key.enter
+key.apps
+key.play
+key.pause
+key.next
+key.none
+key.back
+key.cancel
+key.execute
+key.prior
+ + + + +
+
Selection mode enumerations
+

Syntax

+
mode.none
+mode.single
+mode.multiple
+mode.multi
+mode.multi_unique
+mode.multi_single
+ + +
+
Selection type enumerations
+

Syntax

+
type.file
+type.directory
+type.dir
+type.fixed
+type.root
+type.drive
+type.vhd
+type.removable
+type.dvd
+type.cd
+type.usb
+type.remote
+type.namespace
+type.computer
+type.desktop
+type.recyclebin
+type.taskbar
+type.start
+type.titlebar
+type.edit
+
+type.back
+type.back.dir
+type.back.directory
+type.back.fixed
+type.back.root
+type.back.drive
+type.back.vhd
+type.back.removable
+type.back.dvd
+type.back.usb
+type.back.remote
+type.back.namespace
+type.back.computer
+type.back.recyclebin
+ + +
+
Separator enumerations
+

Enumerations to specify the positioning of separators.

+

Syntax

+
separator.none
+separator.before
+separator.top
+separator.after
+separator.bottom
+separator.both
+sep.none
+sep.before
+sep.top
+sep.after
+sep.bottom
+sep.both
+
+ +
+
Visibility enumerations
+

Enumerations to define the visibility options for elements.

+

Syntax

+
visibility.hidden
+visibility.remove
+visibility.normal
+visibility.enable
+visibility.disable
+visibility.static
+visibility.label
+vis.hidden
+vis.remove
+vis.normal
+vis.enable
+vis.disable
+vis.static
+vis.label
+
+ +
+
Position enumerations
+

Enumerations to define the position options for elements.

+

Syntax

+
pos.auto
+pos.top
+pos.middle
+pos.bottom
+	
+ + +
+
cmd visibility enumerations
+

The flags that specify how an application is to be displayed when it is opened.

+

Syntax

+
cmd.hidden
+cmd.show
+cmd.visible
+cmd.normal
+cmd.maximized
+cmd.minimized
+ + + + +
+
Theme enumerations
+

The enumerations for different types of themes.

+

Syntax

+
theme.auto
+theme.white
+theme.black
+theme.classic
+theme.modern
+ + +
+
View enumerations
+

The enumerations for different types of views.

+

Syntax

+
view.auto
+view.compact
+view.small
+view.medium
+view.large
+view.wide
+ + +
+
Effect enumerations
+

The enumerations for different types of effects.

+

Syntax

+
effect.none
+effect.transparent
+effect.blur
+effect.acrylic
+effect.mica
+effect.tabbed
+ + +
+
Tip enumerations
+

The enumerations for different types of tips.

+

Syntax

+
tip.default
+tip.primary
+tip.info
+tip.success
+tip.warning
+tip.danger
+ + + + + + + + + + diff --git a/docs/functions/index.html b/docs/functions/index.html index 6192cb0..1097a1a 100644 --- a/docs/functions/index.html +++ b/docs/functions/index.html @@ -2,153 +2,6 @@

The functions and variables have unique titles described by fully qualified names that indicate a logical hierarchy.

Shell has a number of functions and variables built into it that are always available. They are listed here in alphabetical order.

-
-
indexof
-

Find the position of a menu item.

-

Syntax

- indexof(expression[, default position]) -
- -
-
if
-

Conditionally executes another statement.

-

Syntax

- if(condition-expression)

- if(condition-expression, true-expression)

- if(condition-expression, true-expression, false-expression) -
- -
-
null
-

Returns a null value.

-

Syntax

- null(expression)

-
- -
-
length (len)
-

Returns length of string and array type

-

Syntax

- length(expression)

-
- -
-
quote
-

Returns text with a double quotation mark.

-

Syntax

- quote(expression) -
- -
-
char
-

Returns the value of the numeric parameter to a character.

-

Syntax

- char(numeric-expression) -
- -
-
var
-

Returns the value of the passed variable

-

Syntax

- var(expression) -
- -
-
tohex
-

Converting the value of the passed numeric expression to hexadecimal string.

-

Syntax

- tohex(numeric-expression) -
- -
-
equal
-

Returns true if the parameters passed are equal.

-

Syntax

- equal(expression-1, expression-2) -
- -
-
not
-

Returns true if the parameters passed are not equal.

-

Syntax

- not(expression-1, expression-2) -
- -
-
greater
-

Returns true if the first parameter is greater than the second parameter.

-

Syntax

- greater(expression-1, expression-2) -
- -
-
less
-

Returns true if the first parameter is less than the second parameter.

-

Syntax

- less(expression-1, expression-2) -
- -
-
shl
-

bitwise left shift.

-

Syntax

- shl(shift-expression, additive-expression) -
- -
-
shr
-

bitwise right shift.

-

Syntax

- shr(shift-expression, additive-expression) -
- -
-
cmd visibility enumerations
-

The flags that specify how an application is to be displayed when it is opened.

-
cmd.hidden
-cmd.show
-cmd.visible
-cmd.normal
-cmd.maximized
-cmd.minimized
-
- -
-
Selection mode enumerations
-

Syntax

-
mode.none
-mode.single
-mode.multiple
-mode.multiunique
-mode.multisingle
-mode.multi
-
- -
-
Selection type enumerations
-

Syntax

-
type.desktop
-type.directory(dir)
-type.drive
-type.dvd
-type.file
-type.fixed
-type.namespace
-type.remote
-type.unknown
-type.usb
-type.vhd
-
- -
Keywords
-
null
-bool
-true
-false
-auto
-none
-default
-
app | color | image | io | key | msg | path | reg | sel | str | sys | user| input | ini | clipboard diff --git a/docs/functions/reg.html b/docs/functions/reg.html index b853ed7..68f1767 100644 --- a/docs/functions/reg.html +++ b/docs/functions/reg.html @@ -29,8 +29,8 @@ reg.qword // REG_QWORD
The function of reading from the Registry.

Syntax

- reg(reg.lm, 'SOFTWARE\Microsoft\Windows NT\CurrentVersion','ProductName')

- reg(reg.cr, 'txtfile\DefaultIcon') + reg('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion','ProductName')

+ reg('HKEY_CURRENT_USER\txtfile\DefaultIcon')
diff --git a/docs/functions/this.html b/docs/functions/this.html index 5ede648..51e3e16 100644 --- a/docs/functions/this.html +++ b/docs/functions/this.html @@ -5,14 +5,19 @@
Syntax

-this.type	// Returns the type of the current item [item = 0, menu = 1, separator = 2]
-this.checked	// Returns true if the current item is checked
-this.pos	// Returns the position of the current item in the context menu
-this.disabled	// Returns true if the current item is disabled
-this.sys	// Returns true if the current item is a system item
-this.title	// Returns the title of the current item
-this.id		// Returns the ID of the current item
-this.count	// Returns the number of items in the context menu
-this.length	// Returns the length of the current item's title
+this.id              // Returns the ID of the current item
+this.name            // Returns the name of the current item
+this.name            // Returns the length of the current item's name
+this.name.length     // Returns the length of the current item's name
+this.title.len       // Returns the title of the current item
+this.title.length    // Returns the length of the current item's title
+this.title.len       // Returns the length of the current item's title
+
+this.type            // Returns the type of the current item [item = 0, menu = 1, separator = 2]
+this.sys             // Returns true if the current item is a system item
+
+this.checked         // Returns true if the current item is checked
+this.disabled        // Returns true if the current item is disabled
+this.pos             // Returns the position of the current item in the context menu
 
diff --git a/docs/functions/unsorted.html b/docs/functions/unsorted.html new file mode 100644 index 0000000..357b722 --- /dev/null +++ b/docs/functions/unsorted.html @@ -0,0 +1,116 @@ +

Unsorted

+ +
+
indexof
+

Find the position of a menu item.

+

Syntax

+ indexof(expression[, default position]) +
+ +
+
if
+

Conditionally executes another statement.

+

Syntax

+ if(condition-expression)

+ if(condition-expression, true-expression)

+ if(condition-expression, true-expression, false-expression) +
+ +
+
null
+

Returns a null value.

+

Syntax

+ null(expression)

+
+ +
+
length (len)
+

Returns length of string and array type

+

Syntax

+ length(expression)

+
+ +
+
quote
+

Returns text with a double quotation mark.

+

Syntax

+ quote(expression) +
+ +
+
char
+

Returns the value of the numeric parameter to a character.

+

Syntax

+ char(numeric-expression) +
+ +
+
var
+

Returns the value of the passed variable

+

Syntax

+ var(expression) +
+ +
+
tohex
+

Converting the value of the passed numeric expression to hexadecimal string.

+

Syntax

+ tohex(numeric-expression) +
+ +
+
equal
+

Returns true if the parameters passed are equal.

+

Syntax

+ equal(expression-1, expression-2) +
+ +
+
not
+

Returns true if the parameters passed are not equal.

+

Syntax

+ not(expression-1, expression-2) +
+ +
+
greater
+

Returns true if the first parameter is greater than the second parameter.

+

Syntax

+ greater(expression-1, expression-2) +
+ +
+
less
+

Returns true if the first parameter is less than the second parameter.

+

Syntax

+ less(expression-1, expression-2) +
+ +
+
shl
+

bitwise left shift.

+

Syntax

+ shl(shift-expression, additive-expression) +
+ +
+
shr
+

bitwise right shift.

+

Syntax

+ shr(shift-expression, additive-expression) +
+ +
Keywords
+
null
+bool
+true
+false
+auto
+none
+default
+
+ +
app | color | image | io | key | msg | path | reg | sel | str | sys | user| input +| ini | clipboard +
+ diff --git a/docs/menu.json b/docs/menu.json index f9b10e1..088d57c 100644 --- a/docs/menu.json +++ b/docs/menu.json @@ -25,6 +25,8 @@ },{ "title":"Functions", "link":"/docs/functions", "items": [ + {"title":"Enums", "link":"/docs/functions/enums"}, + {"title":"Unsorted", "link":"/docs/functions/unsorted"}, {"title":"app", "link":"/docs/functions/app"}, {"title":"appx", "link":"/docs/functions/appx"}, {"title":"color", "link":"/docs/functions/color"},