Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <LibGfx/StylePainter.h>
30#include <LibGUI/Widget.h>
31
32namespace GUI {
33
34class Frame : public Widget {
35 C_OBJECT(Frame)
36public:
37 virtual ~Frame() override;
38
39 int frame_thickness() const { return m_thickness; }
40 void set_frame_thickness(int thickness) { m_thickness = thickness; }
41
42 Gfx::FrameShadow frame_shadow() const { return m_shadow; }
43 void set_frame_shadow(Gfx::FrameShadow shadow) { m_shadow = shadow; }
44
45 Gfx::FrameShape frame_shape() const { return m_shape; }
46 void set_frame_shape(Gfx::FrameShape shape) { m_shape = shape; }
47
48 Gfx::Rect frame_inner_rect_for_size(const Gfx::Size& size) const { return { m_thickness, m_thickness, size.width() - m_thickness * 2, size.height() - m_thickness * 2 }; }
49 Gfx::Rect frame_inner_rect() const { return frame_inner_rect_for_size(size()); }
50
51protected:
52 Frame();
53 void paint_event(PaintEvent&) override;
54
55private:
56 int m_thickness { 0 };
57 Gfx::FrameShadow m_shadow { Gfx::FrameShadow::Plain };
58 Gfx::FrameShape m_shape { Gfx::FrameShape::NoFrame };
59};
60
61}