Difference between revisions of "Talk:CudaText API"

Revision as of 21:59, 29 March 2017

(no text)

toolbar_proc(id_toolbar, id_action, text="", text2="", command="", index=-1, index2=-1)

Perform action on some toolbar.

Param id_toolbar: currently can be "top" for main toolbar. Function gets None, if id_toolbar not correct.

Param id_action possible values:

TOOLBAR_GET_ICON_SIZES: Get sizes of icons, as 2-tuple (width, height).
TOOLBAR_SET_ICON_SIZES: Set sizes of icons. Params:
- index - icon width
- index2 - icon height

TOOLBAR_SET_BUTTON: Change properties of one button. Params:
- index - index of button
- index2 - new icon index, or -1 for none
- text - new button caption, or empty str to not change
- text2 - new button hint, or empty str to not change

TOOLBAR_ADD_ICON: Add an icon (to toolbar's image list) from picture file (png). Params: text - picture filename. Picture sizes must not be equal to toolbar icon sizes. Gets icon index for new icon, or None if cannot add.

TOOLBAR_ADD_BUTTON: Add one button. Params:
- text - button caption, use "-" for separator
- text2 - button hint (tooltip)
- command - description of command. Can be: int_command, str(int_command), "py_module,method", "py_module,method,param".
- index - icon index (in toolbar's image list), or -1 for none

TOOLBAR_ENUM: Enumerates buttons. Gets list of dict, each dict item is: {"cap": str; "cmd": str; "hint": str; "icon": int}.

@@ Line 16: / Line 16: @@
 ** index2 - icon height
-* TOOLBAR_SET_ICON_INDEX: Change icon index for one button. Params:
+* TOOLBAR_SET_BUTTON: Change properties of one button. Params:
-** index - button index
+** index - index of button
-** index2 - icon index (in toolbar's image list), or -1 for none
+** index2 - new icon index, or -1 for none
+** text - new button caption, or empty str to not change
+** text2 - new button hint, or empty str to not change
-* TOOLBAR_ADD_ICON: Add an icon (to toolbar's image list) from picture file (png). Params: text - picture filename (picture size must not be equal to current icon sizes). Gets icon index for new icon, or None if cannot add.
+* TOOLBAR_ADD_ICON: Add an icon (to toolbar's image list) from picture file (png). Params: text - picture filename. Picture sizes must not be equal to toolbar icon sizes. Gets icon index for new icon, or None if cannot add.
 * TOOLBAR_DELETE_ALL: Delete all buttons.
@@ Line 27: / Line 29: @@
 * TOOLBAR_ADD_BUTTON: Add one button. Params:
 ** text - button caption, use "-" for separator
-** text2 - button hint/tooltip
+** text2 - button hint (tooltip)
 ** command - description of command. Can be: int_command, str(int_command), "py_module,method", "py_module,method,param".
 ** index - icon index (in toolbar's image list), or -1 for none
 * TOOLBAR_ENUM: Enumerates buttons. Gets list of dict, each dict item is: {"cap": str; "cmd": str; "hint": str; "icon": int}.