Skip to content

Commit

Permalink
Import dev
Browse files Browse the repository at this point in the history
  • Loading branch information
tobydox committed Jan 28, 2021
1 parent 8aeec31 commit 0b60091
Show file tree
Hide file tree
Showing 33 changed files with 3,336 additions and 5 deletions.
22 changes: 21 additions & 1 deletion InCore.Database/DatabaseSqlQuery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ Properties
++++++++++

.. hlist::
:columns: 1
:columns: 2

* :ref:`error <property_DatabaseSqlQuery_error>`
* :ref:`errorString <property_DatabaseSqlQuery_errorString>`
* :ref:`forwardOnly <property_DatabaseSqlQuery_forwardOnly>`
* :ref:`lastInsertedId <property_DatabaseSqlQuery_lastInsertedId>`
* :ref:`query <property_DatabaseSqlQuery_query>`
* :ref:`results <property_DatabaseSqlQuery_results>`
* :ref:`Object.objectId <property_Object_objectId>`
Expand Down Expand Up @@ -115,6 +116,25 @@ This property holds whether the query is forward only. For some queries :ref:`fo
:**› Attributes**: Writable


.. _property_DatabaseSqlQuery_lastInsertedId:

.. _signal_DatabaseSqlQuery_lastInsertedIdChanged:

.. index::
single: lastInsertedId

lastInsertedId
++++++++++++++

This property holds the object ID of the most recent inserted row if the database supports it. ``undefined`` will be returned if the query did not insert any value or if the database does not report the id back. If more than one row was touched by the insert, the behavior is undefined. For MySQL databases the row's auto-increment field will be returned.

This property was introduced in InCore 2.3.

:**› Type**: Variant
:**› Signal**: lastInsertedIdChanged()
:**› Attributes**: Readonly


.. _property_DatabaseSqlQuery_query:

.. _signal_DatabaseSqlQuery_queryChanged:
Expand Down
1 change: 1 addition & 0 deletions InCore.Foundation/ByteArray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The ByteArray object is used to store and transport binary data and convert it t
This object was introduced in InCore 2.0.

:**› Inherits**: :ref:`Object <object_Object>`
:**› Inherited by**: :ref:`UdpDatagram <object_UdpDatagram>`

Overview
********
Expand Down
3 changes: 3 additions & 0 deletions InCore.Foundation/File.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Properties
* :ref:`IoDevice.atEnd <property_IoDevice_atEnd>`
* :ref:`IoDevice.autoOpen <property_IoDevice_autoOpen>`
* :ref:`IoDevice.bytesAvailable <property_IoDevice_bytesAvailable>`
* :ref:`IoDevice.canReadLine <property_IoDevice_canReadLine>`
* :ref:`IoDevice.deviceErrorString <property_IoDevice_deviceErrorString>`
* :ref:`IoDevice.isOpen <property_IoDevice_isOpen>`
* :ref:`IoDevice.isWritable <property_IoDevice_isWritable>`
Expand All @@ -53,6 +54,7 @@ Methods
* :ref:`IoDevice.peekAll() <method_IoDevice_peekAll>`
* :ref:`IoDevice.read() <method_IoDevice_read>`
* :ref:`IoDevice.readAll() <method_IoDevice_readAll>`
* :ref:`IoDevice.readLine() <method_IoDevice_readLine>`
* :ref:`IoDevice.sync() <method_IoDevice_sync>`
* :ref:`IoDevice.write() <method_IoDevice_write>`
* :ref:`Object.fromJson() <method_Object_fromJson>`
Expand All @@ -65,6 +67,7 @@ Signals
:columns: 1

* :ref:`errorOccurred() <signal_File_errorOccurred>`
* :ref:`IoDevice.lineAvailableForRead() <signal_IoDevice_lineAvailableForRead>`
* :ref:`IoDevice.readyRead() <signal_IoDevice_readyRead>`
* :ref:`Object.completed() <signal_Object_completed>`

Expand Down
54 changes: 53 additions & 1 deletion InCore.Foundation/IoDevice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The IoDevice object is the base interface class of all I/O devices. It provides
Before accessing data the device must be configured through the corresponding properties such as :ref:`readOnly <property_IoDevice_readOnly>`, :ref:`append <property_IoDevice_append>` and :ref:`truncate <property_IoDevice_truncate>`. It can then be opened via :ref:`open() <method_IoDevice_open>`. Objects interacting with I/O devices (e.g. :ref:`CsvWriter <object_CsvWriter>` or :ref:`EventLogFile <object_EventLogFile>`) usually open them automatically.

:**› Inherits**: :ref:`Object <object_Object>`
:**› Inherited by**: :ref:`File <object_File>`
:**› Inherited by**: :ref:`File <object_File>`, :ref:`IpSocket <object_IpSocket>`

Overview
********
Expand All @@ -28,6 +28,7 @@ Properties
* :ref:`atEnd <property_IoDevice_atEnd>`
* :ref:`autoOpen <property_IoDevice_autoOpen>`
* :ref:`bytesAvailable <property_IoDevice_bytesAvailable>`
* :ref:`canReadLine <property_IoDevice_canReadLine>`
* :ref:`deviceErrorString <property_IoDevice_deviceErrorString>`
* :ref:`isOpen <property_IoDevice_isOpen>`
* :ref:`isWritable <property_IoDevice_isWritable>`
Expand All @@ -51,6 +52,7 @@ Methods
* :ref:`peekAll() <method_IoDevice_peekAll>`
* :ref:`read() <method_IoDevice_read>`
* :ref:`readAll() <method_IoDevice_readAll>`
* :ref:`readLine() <method_IoDevice_readLine>`
* :ref:`sync() <method_IoDevice_sync>`
* :ref:`write() <method_IoDevice_write>`
* :ref:`Object.fromJson() <method_Object_fromJson>`
Expand All @@ -62,6 +64,7 @@ Signals
.. hlist::
:columns: 1

* :ref:`lineAvailableForRead() <signal_IoDevice_lineAvailableForRead>`
* :ref:`readyRead() <signal_IoDevice_readyRead>`
* :ref:`Object.completed() <signal_Object_completed>`

Expand Down Expand Up @@ -145,6 +148,25 @@ This property was introduced in InCore 2.0.
:**› Attributes**: Readonly


.. _property_IoDevice_canReadLine:

.. _signal_IoDevice_canReadLineChanged:

.. index::
single: canReadLine

canReadLine
+++++++++++

This property holds whether a complete line of data can be read from the device.

This property was introduced in InCore 2.3.

:**› Type**: Boolean
:**› Signal**: canReadLineChanged()
:**› Attributes**: Readonly


.. _property_IoDevice_deviceErrorString:

.. _signal_IoDevice_deviceErrorStringChanged:
Expand Down Expand Up @@ -376,6 +398,22 @@ This method was introduced in InCore 2.0.



.. _method_IoDevice_readLine:

.. index::
single: readLine

readLine()
++++++++++

This method reads a line from the device (maximum 65535 characters) and returns the result as a UTF-8 encoded string. This function has no way of reporting errors, i.e. an empty string can mean either that no data was currently available for reading, or that an error occurred.

This method was introduced in InCore 2.3.

:**› Returns**: String



.. _method_IoDevice_sync:

.. index::
Expand Down Expand Up @@ -405,6 +443,20 @@ Signals
*******


.. _signal_IoDevice_lineAvailableForRead:

.. index::
single: lineAvailableForRead

lineAvailableForRead()
++++++++++++++++++++++

This signal is emitted once everytime a a complete line of data can be read from the device. It will only be emitted again once new data is available, such as when a new payload of network data has arrived on a network socket, or when a new block of data has been appended to the device.

This signal was introduced in InCore 2.3.



.. _signal_IoDevice_readyRead:

.. index::
Expand Down

0 comments on commit 0b60091

Please sign in to comment.