File indexing completed on 2024-05-12 04:21:15

0001 
0002 /*
0003    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
0004    All rights reserved.
0005 
0006    Redistribution and use in source and binary forms, with or without
0007    modification, are permitted provided that the following conditions
0008    are met:
0009 
0010    1. Redistributions of source code must retain the above copyright
0011       notice, this list of conditions and the following disclaimer.
0012    2. Redistributions in binary form must reproduce the above copyright
0013       notice, this list of conditions and the following disclaimer in the
0014       documentation and/or other materials provided with the distribution.
0015 
0016    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
0017    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
0018    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
0019    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
0020    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
0021    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0022    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0023    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0024    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
0025    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0026 */
0027 
0028 
0029 #ifndef kpDocumentEnvironment_H
0030 #define kpDocumentEnvironment_H
0031 
0032 
0033 #include "environments/kpEnvironmentBase.h"
0034 
0035 
0036 class QWidget;
0037 
0038 class kpAbstractSelection;
0039 
0040 
0041 // Facade for kpDocument clients.
0042 class kpDocumentEnvironment : public kpEnvironmentBase
0043 {
0044 Q_OBJECT
0045 
0046 public:
0047     // Note: Our interface must never publicly leak <mainWindow> or any other
0048     //       classes we are trying to hide as that would defeat the point of
0049     //       the facade.
0050     kpDocumentEnvironment (kpMainWindow *mainWindow);
0051     ~kpDocumentEnvironment () override;
0052 
0053 
0054     QWidget *dialogParent () const;
0055 
0056     void setQueueViewUpdates () const;
0057     void restoreQueueViewUpdates () const;
0058 
0059     void switchToCompatibleTool (const kpAbstractSelection &selection,
0060     // REFACTOR: This is horrible API and terribly named.
0061             bool *isTextChanged) const;
0062     void assertMatchingUIState (const kpAbstractSelection &selection) const;
0063 
0064 
0065 private:
0066     struct kpDocumentEnvironmentPrivate * const d;
0067 };
0068 
0069 
0070 #endif  // kpDocumentEnvironment_H
0071