Files
libreoffice/include/vcl/layout.hxx
Noel Grandin 7444355f1d convert VclButtonBoxStyle to scoped enum
Change-Id: If3d02c9be54a509f85214acbf4a1e6cfd8955dc4
Reviewed-on: https://gerrit.libreoffice.org/32291
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2016-12-22 06:43:22 +00:00

745 lines
23 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_VCL_LAYOUT_HXX
#define INCLUDED_VCL_LAYOUT_HXX
#include <vcl/dllapi.h>
#include <vcl/button.hxx>
#include <vcl/dialog.hxx>
#include <vcl/fixed.hxx>
#include <vcl/IPrioritable.hxx>
#include <vcl/scrbar.hxx>
#include <vcl/split.hxx>
#include <vcl/vclmedit.hxx>
#include <vcl/window.hxx>
#include <vcl/vclptr.hxx>
#include <vcl/IContext.hxx>
#include <set>
class VCL_DLLPUBLIC VclContainer : public vcl::Window,
public vcl::IPrioritable,
public vcl::IContext
{
public:
VclContainer(vcl::Window *pParent, WinBits nStyle = WB_HIDE | WB_CLIPCHILDREN);
//These take into account the external margins of the rWindow widget
//while GetOptimalSize/get_preferred_size and SetPosSizePixel are
//oblivious to them
static Size getLayoutRequisition(const vcl::Window &rWindow);
static void setLayoutPosSize(vcl::Window &rWindow, const Point &rPos, const Size &rSize);
//applies the allocation pos and size onto rWindow via setLayoutPosSize taking into account
//the rWindows alignment desires within that allocation
static void setLayoutAllocation(vcl::Window &rWindow, const Point &rPos, const Size &rSize);
virtual void queue_resize(StateChangedType eReason = StateChangedType::Layout) override;
protected:
//these are the two that need to be implemented by
//containers, figure out how much space you want...
virtual Size calculateRequisition() const = 0;
//..and decide what to do when set to this size
virtual void setAllocation(const Size &rAllocation) = 0;
virtual sal_uInt16 getDefaultAccessibleRole() const override;
// evtl. support for screenshot context menu
virtual void Command(const CommandEvent& rCEvt) override;
public:
//you don't want to override these
virtual Size GetOptimalSize() const override;
virtual void SetPosSizePixel(const Point& rNewPos, const Size& rNewSize) override;
virtual void SetPosPixel(const Point& rAllocPos) override;
virtual void SetSizePixel(const Size& rAllocation) override;
private:
bool m_bLayoutDirty;
};
class VCL_DLLPUBLIC VclBox : public VclContainer
{
protected:
bool m_bHomogeneous;
bool m_bVerticalContainer;
int m_nSpacing;
public:
VclBox(vcl::Window *pParent, bool bHomogeneous, int nSpacing)
: VclContainer(pParent)
, m_bHomogeneous(bHomogeneous)
, m_bVerticalContainer(false)
, m_nSpacing(nSpacing)
{
}
void set_spacing(int nSpacing)
{
m_nSpacing = nSpacing;
}
int get_spacing() const
{
return m_nSpacing;
}
void set_homogeneous(bool bHomogeneous)
{
m_bHomogeneous = bHomogeneous;
}
virtual bool set_property(const OString &rKey, const OString &rValue) override;
protected:
virtual sal_uInt16 getDefaultAccessibleRole() const override;
void accumulateMaxes(const Size &rChildSize, Size &rSize) const;
Size finalizeMaxes(const Size &rSize, sal_uInt16 nVisibleChildren) const;
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
virtual long getPrimaryDimension(const Size &rSize) const = 0;
virtual void setPrimaryDimension(Size &rSize, long) const = 0;
virtual long getPrimaryCoordinate(const Point &rPos) const = 0;
virtual void setPrimaryCoordinate(Point &rPos, long) const = 0;
virtual long getSecondaryDimension(const Size &rSize) const = 0;
virtual void setSecondaryDimension(Size &rSize, long) const = 0;
virtual bool getPrimaryDimensionChildExpand(const vcl::Window &rWindow) const = 0;
};
class VCL_DLLPUBLIC VclVBox : public VclBox
{
public:
VclVBox(vcl::Window *pParent, bool bHomogeneous = false, int nSpacing = 0)
: VclBox(pParent, bHomogeneous, nSpacing)
{
m_bVerticalContainer = true;
}
protected:
virtual long getPrimaryDimension(const Size &rSize) const override
{
return rSize.getHeight();
}
virtual void setPrimaryDimension(Size &rSize, long nHeight) const override
{
rSize.setHeight(nHeight);
}
virtual long getPrimaryCoordinate(const Point &rPos) const override
{
return rPos.getY();
}
virtual void setPrimaryCoordinate(Point &rPos, long nPos) const override
{
rPos.setY(nPos);
}
virtual long getSecondaryDimension(const Size &rSize) const override
{
return rSize.getWidth();
}
virtual void setSecondaryDimension(Size &rSize, long nWidth) const override
{
rSize.setWidth(nWidth);
}
virtual bool getPrimaryDimensionChildExpand(const vcl::Window &rWindow) const override
{
return rWindow.get_expand() || rWindow.get_vexpand();
}
};
class VCL_DLLPUBLIC VclHBox : public VclBox
{
public:
VclHBox(vcl::Window *pParent, bool bHomogeneous = false, int nSpacing = 0)
: VclBox(pParent, bHomogeneous, nSpacing)
{
m_bVerticalContainer = false;
}
protected:
virtual long getPrimaryDimension(const Size &rSize) const override
{
return rSize.getWidth();
}
virtual void setPrimaryDimension(Size &rSize, long nWidth) const override
{
rSize.setWidth(nWidth);
}
virtual long getPrimaryCoordinate(const Point &rPos) const override
{
return rPos.getX();
}
virtual void setPrimaryCoordinate(Point &rPos, long nPos) const override
{
rPos.setX(nPos);
}
virtual long getSecondaryDimension(const Size &rSize) const override
{
return rSize.getHeight();
}
virtual void setSecondaryDimension(Size &rSize, long nHeight) const override
{
rSize.setHeight(nHeight);
}
virtual bool getPrimaryDimensionChildExpand(const vcl::Window &rWindow) const override
{
return rWindow.get_expand() || rWindow.get_hexpand();
}
};
enum class VclButtonBoxStyle
{
Default,
Spread,
Edge,
Start,
End,
Center
};
class VCL_DLLPUBLIC VclButtonBox : public VclBox
{
public:
VclButtonBox(vcl::Window *pParent)
: VclBox(pParent, false, 0/*nSpacing*/)
, m_eLayoutStyle(VclButtonBoxStyle::Default)
{
}
virtual bool set_property(const OString &rKey, const OString &rValue) override;
void sort_native_button_order();
protected:
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
Size addSpacing(const Size &rSize, sal_uInt16 nVisibleChildren) const;
private:
VclButtonBoxStyle m_eLayoutStyle;
struct Requisition
{
std::vector<long> m_aMainGroupDimensions;
std::vector<long> m_aSubGroupDimensions;
Size m_aMainGroupSize;
Size m_aSubGroupSize;
};
Requisition calculatePrimarySecondaryRequisitions() const;
Size addReqGroups(const VclButtonBox::Requisition &rReq) const;
};
class VCL_DLLPUBLIC VclVButtonBox : public VclButtonBox
{
public:
VclVButtonBox(vcl::Window *pParent)
: VclButtonBox(pParent)
{
m_bVerticalContainer = true;
}
protected:
virtual long getPrimaryDimension(const Size &rSize) const override
{
return rSize.getHeight();
}
virtual void setPrimaryDimension(Size &rSize, long nHeight) const override
{
rSize.setHeight(nHeight);
}
virtual long getPrimaryCoordinate(const Point &rPos) const override
{
return rPos.getY();
}
virtual void setPrimaryCoordinate(Point &rPos, long nPos) const override
{
rPos.setY(nPos);
}
virtual long getSecondaryDimension(const Size &rSize) const override
{
return rSize.getWidth();
}
virtual void setSecondaryDimension(Size &rSize, long nWidth) const override
{
rSize.setWidth(nWidth);
}
virtual bool getPrimaryDimensionChildExpand(const vcl::Window &rWindow) const override
{
return rWindow.get_expand() || rWindow.get_vexpand();
}
};
class VCL_DLLPUBLIC VclHButtonBox : public VclButtonBox
{
public:
VclHButtonBox(vcl::Window *pParent)
: VclButtonBox(pParent)
{
m_bVerticalContainer = false;
}
protected:
virtual long getPrimaryDimension(const Size &rSize) const override
{
return rSize.getWidth();
}
virtual void setPrimaryDimension(Size &rSize, long nWidth) const override
{
rSize.setWidth(nWidth);
}
virtual long getPrimaryCoordinate(const Point &rPos) const override
{
return rPos.getX();
}
virtual void setPrimaryCoordinate(Point &rPos, long nPos) const override
{
rPos.setX(nPos);
}
virtual long getSecondaryDimension(const Size &rSize) const override
{
return rSize.getHeight();
}
virtual void setSecondaryDimension(Size &rSize, long nHeight) const override
{
rSize.setHeight(nHeight);
}
virtual bool getPrimaryDimensionChildExpand(const vcl::Window &rWindow) const override
{
return rWindow.get_expand() || rWindow.get_hexpand();
}
};
class VCL_DLLPUBLIC VclGrid : public VclContainer
{
private:
bool m_bRowHomogeneous;
bool m_bColumnHomogeneous;
int m_nRowSpacing;
int m_nColumnSpacing;
public:
struct Value
{
long m_nValue;
bool m_bExpand;
Value() : m_nValue(0), m_bExpand(false) {}
};
private:
Size calculateRequisitionForSpacings(sal_Int32 nRowSpacing, sal_Int32 nColSpacing) const;
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
public:
VclGrid(vcl::Window *pParent)
: VclContainer(pParent)
, m_bRowHomogeneous(false), m_bColumnHomogeneous(false)
, m_nRowSpacing(0), m_nColumnSpacing(0)
{
}
bool get_row_homogeneous() const
{
return m_bRowHomogeneous;
}
bool get_column_homogeneous() const
{
return m_bColumnHomogeneous;
}
void set_row_spacing(int nSpacing)
{
m_nRowSpacing = nSpacing;
}
void set_column_spacing(int nSpacing)
{
m_nColumnSpacing = nSpacing;
}
int get_row_spacing() const
{
return m_nRowSpacing;
}
int get_column_spacing() const
{
return m_nColumnSpacing;
}
virtual bool set_property(const OString &rKey, const OString &rValue) override;
};
class VCL_DLLPUBLIC VclBin : public VclContainer
{
public:
VclBin(vcl::Window *pParent, WinBits nStyle = WB_HIDE | WB_CLIPCHILDREN)
: VclContainer(pParent, nStyle)
{
}
virtual vcl::Window *get_child();
virtual const vcl::Window *get_child() const;
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
};
class VCL_DLLPUBLIC VclVPaned : public VclContainer
{
private:
VclPtr<Splitter> m_pSplitter;
long m_nPosition;
DECL_LINK(SplitHdl, Splitter*, void);
void arrange(const Size& rAllocation, long nFirstHeight, long nSecondHeight);
public:
VclVPaned(vcl::Window *pParent, WinBits nStyle = WB_HIDE | WB_CLIPCHILDREN);
virtual ~VclVPaned() override { disposeOnce(); }
virtual void dispose() override;
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
long get_position() const { return m_nPosition; }
void set_position(long nPosition) { m_nPosition = nPosition; }
};
class VCL_DLLPUBLIC VclFrame : public VclBin
{
private:
VclPtr<vcl::Window> m_pLabel;
private:
friend class VclBuilder;
void designate_label(vcl::Window *pWindow);
DECL_LINK(WindowEventListener, VclWindowEvent&, void);
public:
VclFrame(vcl::Window *pParent)
: VclBin(pParent)
, m_pLabel(nullptr)
{
}
virtual ~VclFrame() override;
virtual void dispose() override;
void set_label(const OUString &rLabel);
OUString get_label() const;
virtual vcl::Window *get_child() override;
virtual const vcl::Window *get_child() const override;
vcl::Window *get_label_widget();
const vcl::Window *get_label_widget() const;
protected:
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
virtual OUString getDefaultAccessibleName() const override;
};
class VCL_DLLPUBLIC VclAlignment : public VclBin
{
public:
VclAlignment(vcl::Window *pParent)
: VclBin(pParent)
, m_nBottomPadding(0)
, m_nLeftPadding(0)
, m_nRightPadding(0)
, m_nTopPadding(0)
, m_fXAlign(0.0)
, m_fXScale(1.0)
, m_fYAlign(0.0)
, m_fYScale(1.0)
{
}
virtual bool set_property(const OString &rKey, const OString &rValue) override;
protected:
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
private:
sal_Int32 m_nBottomPadding;
sal_Int32 m_nLeftPadding;
sal_Int32 m_nRightPadding;
sal_Int32 m_nTopPadding;
float m_fXAlign;
float m_fXScale;
float m_fYAlign;
float m_fYScale;
};
class VCL_DLLPUBLIC VclExpander : public VclBin
{
public:
VclExpander(vcl::Window *pParent)
: VclBin(pParent)
, m_bResizeTopLevel(true)
, m_pDisclosureButton(VclPtr<DisclosureButton>::Create(this))
{
m_pDisclosureButton->SetToggleHdl(LINK(this, VclExpander, ClickHdl));
m_pDisclosureButton->Show();
}
virtual ~VclExpander() override { disposeOnce(); }
virtual void dispose() override;
virtual vcl::Window *get_child() override;
virtual const vcl::Window *get_child() const override;
virtual bool set_property(const OString &rKey, const OString &rValue) override;
bool get_expanded() const
{
return m_pDisclosureButton->IsChecked();
}
void set_expanded(bool bExpanded)
{
m_pDisclosureButton->Check(bExpanded);
}
void set_label(const OUString& rLabel)
{
m_pDisclosureButton->SetText(rLabel);
}
virtual void StateChanged(StateChangedType nType) override;
void SetExpandedHdl( const Link<VclExpander&,void>& rLink ) { maExpandedHdl = rLink; }
protected:
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
private:
bool m_bResizeTopLevel;
VclPtr<DisclosureButton> m_pDisclosureButton;
Link<VclExpander&,void> maExpandedHdl;
DECL_DLLPRIVATE_LINK(ClickHdl, CheckBox&, void);
};
class VCL_DLLPUBLIC VclScrolledWindow : public VclBin
{
public:
VclScrolledWindow(vcl::Window *pParent );
virtual ~VclScrolledWindow() override { disposeOnce(); }
virtual void dispose() override;
virtual vcl::Window *get_child() override;
virtual const vcl::Window *get_child() const override;
virtual bool set_property(const OString &rKey, const OString &rValue) override;
ScrollBar& getVertScrollBar() { return *m_pVScroll; }
ScrollBar& getHorzScrollBar() { return *m_pHScroll; }
Size getVisibleChildSize() const;
//set to true to disable the built-in scrolling callbacks to allow the user
//to override it
void setUserManagedScrolling(bool bUserManagedScrolling) { m_bUserManagedScrolling = bUserManagedScrolling;}
protected:
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
DECL_LINK(ScrollBarHdl, ScrollBar*, void);
void InitScrollBars(const Size &rRequest);
virtual bool EventNotify(NotifyEvent& rNEvt) override;
private:
bool m_bUserManagedScrolling;
VclPtr<ScrollBar> m_pVScroll;
VclPtr<ScrollBar> m_pHScroll;
VclPtr<ScrollBarBox> m_aScrollBarBox;
};
class VCL_DLLPUBLIC VclViewport : public VclBin
{
public:
VclViewport(vcl::Window *pParent)
: VclBin(pParent, WB_HIDE | WB_CLIPCHILDREN)
{
}
protected:
virtual void setAllocation(const Size &rAllocation) override;
};
//Enforces that its children are always the same size as itself.
//Intercepts any Commands intended for its children.
//
//by default the Commands are discarded, inherit from this
//and implement "Command" to get them
class VCL_DLLPUBLIC VclEventBox : public VclBin
{
private:
//Any Commands an EventBoxHelper receives are forwarded to its parent
//The VclEventBox ensures that m_aEventBoxHelper is the
//first child and is transparent, but covers the rest of the children
class EventBoxHelper : public vcl::Window
{
public:
EventBoxHelper(vcl::Window* pParent)
: Window(pParent, 0)
{
SetSizePixel(pParent->GetSizePixel());
EnableChildTransparentMode();
SetPaintTransparent(true);
SetBackground();
}
virtual void Command(const CommandEvent& rCEvt) override
{
GetParent()->Command(rCEvt);
}
};
VclPtr<EventBoxHelper> m_aEventBoxHelper;
protected:
virtual void dispose() override;
virtual ~VclEventBox() override;
public:
VclEventBox(vcl::Window* pParent)
: VclBin(pParent)
, m_aEventBoxHelper(VclPtr<EventBoxHelper>::Create(this))
{
m_aEventBoxHelper->Show();
}
virtual vcl::Window *get_child() override;
virtual const vcl::Window *get_child() const override;
virtual Size calculateRequisition() const override;
virtual void setAllocation(const Size &rAllocation) override;
virtual void Command(const CommandEvent& rCEvt) override;
};
enum class VclSizeGroupMode
{
NONE,
Horizontal,
Vertical,
Both
};
class VCL_DLLPUBLIC VclSizeGroup
{
private:
std::set< VclPtr<vcl::Window> > m_aWindows;
bool m_bIgnoreHidden;
VclSizeGroupMode m_eMode;
void trigger_queue_resize();
public:
VclSizeGroup()
: m_bIgnoreHidden(false)
, m_eMode(VclSizeGroupMode::Horizontal)
{
}
void insert(vcl::Window *pWindow)
{
m_aWindows.insert(VclPtr<vcl::Window>(pWindow));
}
void erase(vcl::Window *pWindow)
{
m_aWindows.erase(VclPtr<vcl::Window>(pWindow));
}
const std::set< VclPtr<vcl::Window> >& get_widgets() const
{
return m_aWindows;
}
std::set< VclPtr<vcl::Window> >& get_widgets()
{
return m_aWindows;
}
void set_ignore_hidden(bool bIgnoreHidden);
bool get_ignore_hidden() const
{
return m_bIgnoreHidden;
}
void set_mode(VclSizeGroupMode eMode);
VclSizeGroupMode get_mode() const
{
return m_eMode;
}
bool set_property(const OString &rKey, const OString &rValue);
};
enum class VclButtonsType
{
NONE,
Ok,
Close,
Cancel,
YesNo,
OkCancel
};
enum class VclMessageType
{
Info,
Warning,
Question,
Error
};
class VCL_DLLPUBLIC MessageDialog : public Dialog
{
private:
VclButtonsType m_eButtonsType;
VclMessageType m_eMessageType;
VclPtr<VclBox> m_pOwnedContentArea;
VclPtr<VclButtonBox> m_pOwnedActionArea;
VclPtr<VclGrid> m_pGrid;
VclPtr<FixedImage> m_pImage;
VclPtr<VclMultiLineEdit> m_pPrimaryMessage;
VclPtr<VclMultiLineEdit> m_pSecondaryMessage;
std::vector<VclPtr<PushButton> > m_aOwnedButtons;
std::map< VclPtr<const vcl::Window>, short> m_aResponses;
OUString m_sPrimaryString;
OUString m_sSecondaryString;
DECL_DLLPRIVATE_LINK(ButtonHdl, Button *, void);
void setButtonHandlers(VclButtonBox *pButtonBox);
short get_response(const vcl::Window *pWindow) const;
void create_owned_areas();
friend class VclPtr<MessageDialog>;
MessageDialog(vcl::Window* pParent, WinBits nStyle);
public:
MessageDialog(vcl::Window* pParent,
const OUString &rMessage,
VclMessageType eMessageType = VclMessageType::Error,
VclButtonsType eButtonsType = VclButtonsType::Ok);
MessageDialog(vcl::Window* pParent, const OString& rID, const OUString& rUIXMLDescription);
virtual bool set_property(const OString &rKey, const OString &rValue) override;
virtual short Execute() override;
///Emitted when an action widget is clicked
virtual void response(short nResponseId);
OUString const & get_primary_text() const;
OUString const & get_secondary_text() const;
void set_primary_text(const OUString &rPrimaryString);
void set_secondary_text(const OUString &rSecondaryString);
virtual ~MessageDialog() override;
virtual void dispose() override;
static void SetMessagesWidths(vcl::Window *pParent, VclMultiLineEdit *pPrimaryMessage,
VclMultiLineEdit *pSecondaryMessage);
};
VCL_DLLPUBLIC Size bestmaxFrameSizeForScreenSize(const Size &rScreenSize);
//Get first window of a pTopLevel window as
//if any intermediate layout widgets didn't exist
//i.e. acts like pChild = pChild->GetWindow(GetWindowType::FirstChild);
//in a flat hierarchy where dialogs only have one layer
//of children
VCL_DLLPUBLIC vcl::Window* firstLogicalChildOfParent(vcl::Window *pTopLevel);
//Get next window after pChild of a pTopLevel window as
//if any intermediate layout widgets didn't exist
//i.e. acts like pChild = pChild->GetWindow(GetWindowType::Next);
//in a flat hierarchy where dialogs only have one layer
//of children
VCL_DLLPUBLIC vcl::Window* nextLogicalChildOfParent(vcl::Window *pTopLevel, vcl::Window *pChild);
//Get previous window before pChild of a pTopLevel window as
//if any intermediate layout widgets didn't exist
//i.e. acts like pChild = pChild->GetWindow(GetWindowType::Prev);
//in a flat hierarchy where dialogs only have one layer
//of children
VCL_DLLPUBLIC vcl::Window* prevLogicalChildOfParent(vcl::Window *pTopLevel, vcl::Window *pChild);
//Returns true is the Window has a single child which is a container
VCL_DLLPUBLIC bool isLayoutEnabled(const vcl::Window *pWindow);
inline bool isContainerWindow(const vcl::Window &rWindow)
{
WindowType eType = rWindow.GetType();
return eType == WINDOW_CONTAINER || eType == WINDOW_SCROLLWINDOW ||
(eType == WINDOW_DOCKINGWINDOW && ::isLayoutEnabled(&rWindow));
}
inline bool isContainerWindow(const vcl::Window *pWindow)
{
return pWindow && isContainerWindow(*pWindow);
}
//Returns true if the containing dialog is doing its initial
//layout and isn't visible yet
VCL_DLLPUBLIC bool isInitialLayout(const vcl::Window *pWindow);
// retro-fitting utilities
//Get a Size which is large enough to contain all children with
//an equal amount of space at top left and bottom right
Size getLegacyBestSizeForChildren(const vcl::Window &rWindow);
//Get first parent which is not a layout widget
VCL_DLLPUBLIC vcl::Window* getNonLayoutParent(vcl::Window *pParent);
//return true if this window and its stack of containers are all shown
bool isVisibleInLayout(const vcl::Window *pWindow);
//return true if this window and its stack of containers are all enabled
bool isEnabledInLayout(const vcl::Window *pWindow);
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */