@openui5/ts-types 1.114.0 → 1.115.1

package/types/sap.ui.codeeditor.d.ts

@@ -1,9 +1,9 @@
-// For Library Version: 1.114.0
+// For Library Version: 1.115.1
 
 declare namespace sap {
   namespace ui {
     /**
-     * @SINCE 1.48
+     * @since 1.48
      *
      * UI5 library: sap.ui.codeeditor.
      */
@@ -73,7 +73,7 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
-         * @SINCE 1.48.1
+         * @since 1.48.1
          *
          * Sets whether the editor height should auto expand to a maximum number of lines. After reaching the maximum
          * number of lines specified, the content of the `CodeEditor` will become scrollable.
@@ -106,16 +106,44 @@ declare namespace sap {
         /**
          * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
          */
-        liveChange?: (oEvent: sap.ui.base.Event) => void;
+        liveChange?: (
+          oEvent: sap.ui.base.Event<sap.ui.codeeditor.CodeEditor$LiveChangeEventParameters>
+        ) => void;
 
         /**
          * Fired when the value has changed and the focus leaves the code editor.
          */
-        change?: (oEvent: sap.ui.base.Event) => void;
+        change?: (
+          oEvent: sap.ui.base.Event<sap.ui.codeeditor.CodeEditor$ChangeEventParameters>
+        ) => void;
+      }
+
+      interface CodeEditor$ChangeEventParameters {
+        /**
+         * The current value of the code editor.
+         */
+        value?: string;
+
+        /**
+         * The old value of the code editor.
+         */
+        oldValue?: string;
+      }
+
+      interface CodeEditor$LiveChangeEventParameters {
+        /**
+         * The current value of the code editor.
+         */
+        value?: string;
+
+        /**
+         * The underlying change event of the third-party code editor.
+         */
+        editorEvent?: object;
       }
 
       /**
-       * @SINCE 1.46
+       * @since 1.46
        *
        * Allows to visualize source code of various types with syntax highlighting, line numbers in editable and
        * read only mode. Use this control in scenarios where the user should be able to inspect and edit source
@@ -183,7 +211,7 @@ declare namespace sap {
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
         /**
-         * @SINCE 1.52
+         * @since 1.52
          *
          * Defines custom completer - object implementing a getCompletions method. The method has two parameters
          * - fnCallback method and context object. Context object provides details about oPos and sPrefix as provided
@@ -216,7 +244,7 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$ChangeEvent) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -236,7 +264,7 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$ChangeEvent) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -261,7 +289,7 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -281,7 +309,7 @@ declare namespace sap {
           /**
            * The function to be called when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
           /**
            * Context object to call the event handler with. Defaults to this `sap.ui.codeeditor.CodeEditor` itself
            */
@@ -298,7 +326,7 @@ declare namespace sap {
           /**
            * The function to be called, when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$ChangeEvent) => void,
           /**
            * Context object on which the given function had to be called
            */
@@ -315,14 +343,14 @@ declare namespace sap {
           /**
            * The function to be called, when the event occurs
            */
-          fnFunction: (p1: sap.ui.base.Event) => void,
+          fnFunction: (p1: CodeEditor$LiveChangeEvent) => void,
           /**
            * Context object on which the given function had to be called
            */
           oListener?: object
         ): this;
         /**
-         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
          *
          * Fires event {@link #event:change change} to attached listeners.
          *
@@ -332,19 +360,10 @@ declare namespace sap {
           /**
            * Parameters to pass along with the event
            */
-          mParameters?: {
-            /**
-             * The current value of the code editor.
-             */
-            value?: string;
-            /**
-             * The old value of the code editor.
-             */
-            oldValue?: string;
-          }
+          mParameters?: sap.ui.codeeditor.CodeEditor$ChangeEventParameters
         ): this;
         /**
-         * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
          *
          * Fires event {@link #event:liveChange liveChange} to attached listeners.
          *
@@ -354,16 +373,7 @@ declare namespace sap {
           /**
            * Parameters to pass along with the event
            */
-          mParameters?: {
-            /**
-             * The current value of the code editor.
-             */
-            value?: string;
-            /**
-             * The underlying change event of the third-party code editor.
-             */
-            editorEvent?: object;
-          }
+          mParameters?: sap.ui.codeeditor.CodeEditor$LiveChangeEventParameters
         ): this;
         /**
          * Sets the focus to the code editor
@@ -431,7 +441,7 @@ declare namespace sap {
          */
         getLineNumbers(): boolean;
         /**
-         * @SINCE 1.48.1
+         * @since 1.48.1
          *
          * Gets current value of property {@link #getMaxLines maxLines}.
          *
@@ -509,7 +519,7 @@ declare namespace sap {
          */
         getWidth(): sap.ui.core.CSSSize;
         /**
-         * @SINCE 1.54.1
+         * @since 1.54.1
          *
          * Pretty-prints the content of the editor
          */
@@ -578,7 +588,7 @@ declare namespace sap {
           bLineNumbers?: boolean
         ): this;
         /**
-         * @SINCE 1.48.1
+         * @since 1.48.1
          *
          * Sets a new value for property {@link #getMaxLines maxLines}.
          *
@@ -698,6 +708,22 @@ declare namespace sap {
           sWidth?: sap.ui.core.CSSSize
         ): this;
       }
+
+      /**
+       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'CodeEditor$ChangeEventParameters'
+       * in 1.115.1 and any later releases.
+       */
+      type $CodeEditorChangeEventParameters = sap.ui.codeeditor.CodeEditor$ChangeEventParameters;
+
+      type CodeEditor$ChangeEvent = sap.ui.base.Event<CodeEditor$ChangeEventParameters>;
+
+      /**
+       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'CodeEditor$LiveChangeEventParameters'
+       * in 1.115.1 and any later releases.
+       */
+      type $CodeEditorLiveChangeEventParameters = sap.ui.codeeditor.CodeEditor$LiveChangeEventParameters;
+
+      type CodeEditor$LiveChangeEvent = sap.ui.base.Event<CodeEditor$LiveChangeEventParameters>;
     }
   }