File indexing completed on 2024-12-08 04:17:25

0001 /* This file is part of the KDE project
0002    Copyright (C) 2003-2017 Jarosław Staniek <staniek@kde.org>
0003 
0004    This program is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU Library General Public
0006    License as published by the Free Software Foundation; either
0007    version 2 of the License, or (at your option) any later version.
0008 
0009    This program is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    Library General Public License for more details.
0013 
0014    You should have received a copy of the GNU Library General Public License
0015    along with this program; see the file COPYING.  If not, write to
0016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018 */
0019 
0020 #ifndef KDB_KDBSELECTSTATEMENTOPTIONS_H
0021 #define KDB_KDBSELECTSTATEMENTOPTIONS_H
0022 
0023 #include "kdb_export.h"
0024 
0025 class KDbConnection;
0026 class KDbQuerySchema;
0027 class KDbTableSchema;
0028 class KDbEscapedString;
0029 
0030 //! Options used in KDbNativeStatementBuilder::generateSelectStatement()
0031 class KDB_EXPORT KDbSelectStatementOptions //SDC: operator==
0032 {
0033 public:
0034     /*!
0035     @getter
0036     @return @c true if record IDs should be also retrieved. @c false by default.
0037     @setter
0038     Specifies whether record IDs should be also retrieved.
0039     */
0040     bool alsoRetrieveRecordId; //SDC: default=false
0041 
0042     /*!
0043     @getter
0044     @return @c true if relations (LEFT OUTER JOIN) for visible lookup columns should be added.
0045     @c false is used only when user-visible statement is generated e.g. the one used in Kexi's
0046     Query Designer. @c true by default.
0047     @setter
0048     Specifies whether if relations (LEFT OUTER JOIN) for visible lookup columns should be added.
0049     */
0050     bool addVisibleLookupColumns; //SDC: default=true
0051 };
0052 
0053 #endif