diff options
| author | Tomaž Vajngerl <tomaz.vajngerl@collabora.co.uk> | 2022-01-10 17:16:30 +0900 |
|---|---|---|
| committer | Tomaž Vajngerl <quikee@gmail.com> | 2022-01-10 13:51:08 +0100 |
| commit | e17f003b5feb8da26498f317914eb2eb83be834b (patch) | |
| tree | 711d1099f7a37ccc5e137fbdf9a1b4960f1de54b /sd/source/ui | |
| parent | 13a524392d6788727b27ad11aef20973ef3042f8 (diff) | |
document GenericCheckDialog, GraphicSizeCheck and related classes
Change-Id: If3f8c33601f7823c87b75d601e0b8620d4bfe197
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/128205
Tested-by: Tomaž Vajngerl <quikee@gmail.com>
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>
Diffstat (limited to 'sd/source/ui')
| -rw-r--r-- | sd/source/ui/inc/tools/GraphicSizeCheck.hxx | 13 | ||||
| -rw-r--r-- | sd/source/ui/tools/GraphicSizeCheck.cxx | 8 |
2 files changed, 21 insertions, 0 deletions
diff --git a/sd/source/ui/inc/tools/GraphicSizeCheck.hxx b/sd/source/ui/inc/tools/GraphicSizeCheck.hxx index 9da3d569bd3a..1b0c4ff39559 100644 --- a/sd/source/ui/inc/tools/GraphicSizeCheck.hxx +++ b/sd/source/ui/inc/tools/GraphicSizeCheck.hxx @@ -17,6 +17,10 @@ namespace sd { +/** + * Class resposible to check if a graphic object violates the size + * constraints and store the results. + */ class GraphicSizeViolation final { private: @@ -45,6 +49,10 @@ public: sal_Int32 getDPIY() { return m_nDPIY; } }; +/** + * Run the graphic size checks for all the graphic objects in the DOM + * and store a list of violations. + */ class GraphicSizeCheck final { private: @@ -65,6 +73,7 @@ public: } }; +/** The UI part of the GraphicSizeViolation used by GenericCheckDialog */ class GraphicSizeCheckGUIEntry : public svx::CheckData { private: @@ -90,6 +99,10 @@ public: void runProperties() override; }; +/** + * The UI part presenting the graphic size check results, which is + * used by GenericCheckDialog + */ class GraphicSizeCheckGUIResult : public svx::CheckDataCollection { public: diff --git a/sd/source/ui/tools/GraphicSizeCheck.cxx b/sd/source/ui/tools/GraphicSizeCheck.cxx index 14bfcf3353b9..14a5b02d4484 100644 --- a/sd/source/ui/tools/GraphicSizeCheck.cxx +++ b/sd/source/ui/tools/GraphicSizeCheck.cxx @@ -24,6 +24,10 @@ namespace sd { namespace { +/** + * Intefece for the visitor class, which handles each visited SdrObject + * in the DOM. + */ class ModelTraverseHandler { public: @@ -32,6 +36,10 @@ public: virtual void handleSdrObject(SdrObject* pObject) = 0; }; +/** + * Traverses the DOM and calls a handler for each object (SdrObject) it + * encounters. + */ class ModelTraverser { private: |