lazarus/docs/xml/lcl/dbactns.xml

<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
    ====================================================================
      DBActns
    ====================================================================
    -->
    <module name="DBActns">
      <short>
        Standard actions to be used for navigating and manipulating datasets derived from external databases
      </short>
      <descr></descr>

      <!-- unresolved type reference Visibility: default -->
      <element name="Classes">
        <short></short>
      </element>

      <!-- unresolved type reference Visibility: default -->
      <element name="DB">
        <short></short>
      </element>

      <!-- unresolved type reference Visibility: default -->
      <element name="ActnList">
        <short></short>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetAction" link="#lcl.ActnList.TAction">
        <short>
          <var>TDataSetAction</var> is the base class for all other standard <var>TDataSet</var> actions
        </short>
        <descr>
          <p>
            <var>TDataSetAction</var> is a TAction descendant that is the base class for all other standard <var>TDataSet</var> actions. TDataSetAction provides properties and methods which enable the action to be used with a DataSource and its associated dataset. TDataSetAction provides an overridden Notification method to perform component notifications for DataSource and its DataSet.
          </p>
          <p>
            Applications do not use instances of TDataSetAction; use one of the descendant classes that perform a specific action for a dataset.
          </p>
        </descr>
        <errors></errors>
        <seealso></seealso>
      </element>

      <!-- variable Visibility: private -->
      <element name="TDataSetAction.FDataSource">
        <short></short>
      </element>

      <!-- procedure Visibility: private -->
      <element name="TDataSetAction.SetDataSource">
        <short>Sets the value in the DataSource property</short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetAction.SetDataSource.Value">
        <short>New value for the property</short>
      </element>

      <!-- procedure Visibility: protected -->
      <element name="TDataSetAction.Notification">
        <short>Performs notications when a component is added or removed</short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetAction.Notification.AComponent">
        <short></short>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetAction.Notification.Operation">
        <short></short>
      </element>

      <!-- function Visibility: protected -->
      <element name="TDataSetAction.GetDataSet">
        <short>Gets the value in the Dataset property for the specified target</short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- function result Visibility: default -->
      <element name="TDataSetAction.GetDataSet.Result">
        <short></short>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetAction.GetDataSet.Target">
        <short></short>
      </element>

      <!-- function Visibility: public -->
      <element name="TDataSetAction.HandlesTarget">
        <short>Indicates if the action is handled for the specified target</short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>

      <!-- function result Visibility: default -->
      <element name="TDataSetAction.HandlesTarget.Result">
        <short></short>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetAction.HandlesTarget.Target">
        <short></short>
      </element>

      <!-- property Visibility: public -->
      <element name="TDataSetAction.DataSource">
        <short>
          DataSource with the dataset for the action
        </short>
        <descr>
          <p>
            <var>DataSource</var> is the locally-stored series of records forming the <var>DataSet</var>, derived (by a query) from the external database.
          </p>
        </descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetFirst">
        <short>
          <var>TDataSetFirst</var> moves to first record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>

      <!-- procedure Visibility: public -->
      <element name="TDataSetFirst.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetFirst.ExecuteTarget.Target">
        <short></short>
      </element>

      <!-- procedure Visibility: public -->
      <element name="TDataSetFirst.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetFirst.UpdateTarget.Target">
        <short></short>
      </element>

      <!-- property Visibility: published -->
      <element name="TDataSetFirst.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetLast">
        <short>
          <var>TDataSetLast</var> moves to last record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetLast.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetLast.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetLast.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetLast.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetLast.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetNext">
        <short>
          <var>TDataSetNext</var> moves to next record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetNext.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetNext.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetNext.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetNext.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetNext.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetPrior">
        <short>
          <var>TDataSetPrior</var> moves to previous (prior) record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetPrior.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetPrior.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetPrior.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetPrior.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetPrior.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetRefresh">
        <short>
          <var>TDataSetRefresh</var> refreshes the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetRefresh.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetRefresh.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetRefresh.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetRefresh.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetRefresh.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetCancel">
        <short>
          <var>TDataSetCancel</var> cancels the previous operation on the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetCancel.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetCancel.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetCancel.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetCancel.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetCancel.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetDelete">
        <short>
          <var>TDataSetDelete</var> deletes the current record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetDelete.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetDelete.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetDelete.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetDelete.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetDelete.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetEdit">
        <short>
          <var>TDataSetEdit</var> edits the current record in the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetEdit.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetEdit.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetEdit.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetEdit.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetEdit.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetInsert">
        <short>
          <var>TDataSetInsert</var> inserts (appends) a new record into the <var>DataSet</var>
        </short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetInsert.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetInsert.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetInsert.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetInsert.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetInsert.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>

      <!-- object Visibility: default -->
      <element name="TDataSetPost">
        <short>
          <var>TDataSetPost</var> posts changes on the current record to the <var>DataSet</var>
        </short>
        <descr>
          <p>
            <var>TDataSetPost</var> posts the editing changes on the current record permanently into the <var>DataSet</var> (may need a separate action to make changes permanently in external database).
          </p>
        </descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetPost.ExecuteTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetPost.ExecuteTarget.Target">
        <short></short>
      </element>
      <!-- procedure Visibility: public -->
      <element name="TDataSetPost.UpdateTarget">
        <short></short>
        <descr></descr>
        <errors></errors>
        <seealso></seealso>
      </element>
      <!-- argument Visibility: default -->
      <element name="TDataSetPost.UpdateTarget.Target">
        <short></short>
      </element>
      <!-- property Visibility: published -->
      <element name="TDataSetPost.DataSource">
        <short></short>
        <descr></descr>
        <seealso></seealso>
      </element>
    </module>
    <!-- DBActns -->

  </package>
</fpdoc-descriptions>