LibreOffice Module vcl (master)  1
Classes | Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | List of all members
SalFrame Class Referenceabstract

A SalFrame is a system window (e.g. an X11 window). More...

#include <salframe.hxx>

Inheritance diagram for SalFrame:
[legend]
Collaboration diagram for SalFrame:
[legend]

Classes

struct  SalPointerState
 

Public Member Functions

 SalFrame ()
 
virtual ~SalFrame () override
 
virtual long GetWidth () const override
 
virtual long GetHeight () const override
 
virtual bool IsOffScreen () const override
 
virtual SalGraphicsAcquireGraphics ()=0
 
virtual void ReleaseGraphics (SalGraphics *pGraphics)=0
 
virtual bool PostEvent (std::unique_ptr< ImplSVEvent > pData)=0
 
virtual void SetTitle (const OUString &rTitle)=0
 
virtual void SetIcon (sal_uInt16 nIcon)=0
 
virtual void SetRepresentedURL (const OUString &)
 
virtual void SetMenu (SalMenu *pSalMenu)=0
 
virtual void DrawMenuBar ()=0
 
virtual void SetExtendedFrameStyle (SalExtStyle nExtStyle)=0
 
virtual void Show (bool bVisible, bool bNoActivate=false)=0
 
virtual void SetMinClientSize (long nWidth, long nHeight)=0
 
virtual void SetMaxClientSize (long nWidth, long nHeight)=0
 
virtual void SetPosSize (long nX, long nY, long nWidth, long nHeight, sal_uInt16 nFlags)=0
 
virtual void GetClientSize (long &rWidth, long &rHeight)=0
 
virtual void GetWorkArea (tools::Rectangle &rRect)=0
 
virtual SalFrameGetParent () const =0
 
SalFrameGeometry GetGeometry () const
 
const SalFrameGeometryGetUnmirroredGeometry () const
 
virtual void SetWindowState (const SalFrameState *pState)=0
 
virtual bool GetWindowState (SalFrameState *pState)=0
 
virtual void ShowFullScreen (bool bFullScreen, sal_Int32 nDisplay)=0
 
virtual void PositionByToolkit (const tools::Rectangle &, FloatWinPopupFlags)
 
virtual void StartPresentation (bool bStart)=0
 
virtual void SetAlwaysOnTop (bool bOnTop)=0
 
virtual void ToTop (SalFrameToTop nFlags)=0
 
virtual void SetPointer (PointerStyle ePointerStyle)=0
 
virtual void CaptureMouse (bool bMouse)=0
 
virtual void SetPointerPos (long nX, long nY)=0
 
virtual void Flush ()=0
 
virtual void Flush (const tools::Rectangle &)
 
virtual void SetInputContext (SalInputContext *pContext)=0
 
virtual void EndExtTextInput (EndExtTextInputFlags nFlags)=0
 
virtual OUString GetKeyName (sal_uInt16 nKeyCode)=0
 
virtual bool MapUnicodeToKeyCode (sal_Unicode aUnicode, LanguageType aLangType, vcl::KeyCode &rKeyCode)=0
 
virtual LanguageType GetInputLanguage ()=0
 
virtual void UpdateSettings (AllSettings &rSettings)=0
 
virtual void Beep ()=0
 
virtual const SystemEnvDataGetSystemData () const =0
 
virtual SalPointerState GetPointerState ()=0
 
virtual KeyIndicatorState GetIndicatorState ()=0
 
virtual void SimulateKeyPress (sal_uInt16 nKeyCode)=0
 
virtual void SetParent (SalFrame *pNewParent)=0
 
virtual bool SetPluginParent (SystemParentData *pNewParent)=0
 
virtual void SetScreenNumber (unsigned int nScreen)=0
 
virtual void SetApplicationID (const OUString &rApplicationID)=0
 
virtual void ResetClipRegion ()=0
 
virtual void BeginSetClipRegion (sal_uInt32 nRects)=0
 
virtual void UnionClipRegion (long nX, long nY, long nWidth, long nHeight)=0
 
virtual void EndSetClipRegion ()=0
 
virtual void SetModal (bool)
 
virtual bool GetModal () const
 
virtual bool ShowTooltip (const OUString &, const tools::Rectangle &)
 
virtual voidShowPopover (const OUString &, vcl::Window *, const tools::Rectangle &, QuickHelpFlags)
 
virtual bool UpdatePopover (void *, const OUString &, vcl::Window *, const tools::Rectangle &)
 
virtual bool HidePopover (void *)
 
virtual weld::WindowGetFrameWeld () const
 
void SetCallback (vcl::Window *pWindow, SALFRAMEPROC pProc)
 
vcl::WindowGetWindow () const
 
void SetModalHierarchyHdl (const Link< bool, void > &rLink)
 
void NotifyModalHierarchy (bool bModal)
 
bool CallCallback (SalEvent nEvent, const void *pEvent) const
 
- Public Member Functions inherited from vcl::DeletionNotifier
void addDel (DeletionListener *pListener)
 
void removeDel (DeletionListener *pListener)
 
- Public Member Functions inherited from SalGeometryProvider
virtual ~SalGeometryProvider ()
 

Public Attributes

SalFrameGeometry maGeometry = {}
 absolute, unmirrored values More...
 

Protected Attributes

std::unique_ptr< weld::Windowm_xFrameWeld
 

Private Attributes

VclPtr< vcl::Windowm_pWindow
 
SALFRAMEPROC m_pProc
 
Link< bool, voidm_aModalHierarchyHdl
 

Additional Inherited Members

- Protected Member Functions inherited from vcl::DeletionNotifier
 DeletionNotifier ()
 
 ~DeletionNotifier ()
 
void notifyDelete ()
 

Detailed Description

A SalFrame is a system window (e.g. an X11 window).

Definition at line 112 of file salframe.hxx.

Constructor & Destructor Documentation

SalFrame::SalFrame ( )

Definition at line 75 of file salvtables.cxx.

SalFrame::~SalFrame ( )
overridevirtual

Definition at line 84 of file salvtables.cxx.

Member Function Documentation

virtual SalGraphics* SalFrame::AcquireGraphics ( )
pure virtual
virtual void SalFrame::Beep ( )
pure virtual
virtual void SalFrame::BeginSetClipRegion ( sal_uInt32  nRects)
pure virtual
bool SalFrame::CallCallback ( SalEvent  nEvent,
const void pEvent 
) const
inline

Definition at line 298 of file salframe.hxx.

Referenced by Qt5Frame::CallCallback(), and X11SalFrame::Close().

virtual void SalFrame::CaptureMouse ( bool  bMouse)
pure virtual
virtual void SalFrame::DrawMenuBar ( )
pure virtual
virtual void SalFrame::EndExtTextInput ( EndExtTextInputFlags  nFlags)
pure virtual
virtual void SalFrame::EndSetClipRegion ( )
pure virtual
virtual void SalFrame::Flush ( )
pure virtual

Implemented in GtkSalFrame, X11SalFrame, Qt5Frame, AquaSalFrame, WinSalFrame, and SvpSalFrame.

Referenced by Flush().

void SalFrame::Flush ( const tools::Rectangle )
virtual

Reimplemented in AquaSalFrame.

Definition at line 96 of file salvtables.cxx.

References Flush().

virtual void SalFrame::GetClientSize ( long &  rWidth,
long &  rHeight 
)
pure virtual
weld::Window * SalFrame::GetFrameWeld ( ) const
virtual
SalFrameGeometry SalFrame::GetGeometry ( ) const
virtual long SalFrame::GetHeight ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 131 of file salframe.hxx.

References SalFrameGeometry::nHeight.

virtual KeyIndicatorState SalFrame::GetIndicatorState ( )
pure virtual
virtual LanguageType SalFrame::GetInputLanguage ( )
pure virtual
virtual OUString SalFrame::GetKeyName ( sal_uInt16  nKeyCode)
pure virtual
virtual bool SalFrame::GetModal ( ) const
inlinevirtual

Reimplemented in GtkSalFrame, and Qt5Frame.

Definition at line 254 of file salframe.hxx.

virtual SalFrame* SalFrame::GetParent ( ) const
pure virtual
virtual SalPointerState SalFrame::GetPointerState ( )
pure virtual
virtual const SystemEnvData* SalFrame::GetSystemData ( ) const
pure virtual
const SalFrameGeometry& SalFrame::GetUnmirroredGeometry ( ) const
inline

Definition at line 165 of file salframe.hxx.

virtual long SalFrame::GetWidth ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 130 of file salframe.hxx.

References SalFrameGeometry::nWidth.

vcl::Window* SalFrame::GetWindow ( ) const
inline

Definition at line 290 of file salframe.hxx.

Referenced by GetFrameWeld().

virtual bool SalFrame::GetWindowState ( SalFrameState pState)
pure virtual
virtual void SalFrame::GetWorkArea ( tools::Rectangle rRect)
pure virtual
virtual bool SalFrame::HidePopover ( void )
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 278 of file salframe.hxx.

Referenced by Help::HidePopover().

virtual bool SalFrame::IsOffScreen ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 132 of file salframe.hxx.

virtual bool SalFrame::MapUnicodeToKeyCode ( sal_Unicode  aUnicode,
LanguageType  aLangType,
vcl::KeyCode rKeyCode 
)
pure virtual
void SalFrame::NotifyModalHierarchy ( bool  bModal)
inline

Definition at line 293 of file salframe.hxx.

References Link< class, class >::Call().

Referenced by Dialog::SetModalInputMode().

virtual void SalFrame::PositionByToolkit ( const tools::Rectangle ,
FloatWinPopupFlags   
)
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 173 of file salframe.hxx.

Referenced by FloatingWindow::StartPopupMode().

virtual bool SalFrame::PostEvent ( std::unique_ptr< ImplSVEvent pData)
pure virtual
virtual void SalFrame::ReleaseGraphics ( SalGraphics pGraphics)
pure virtual
virtual void SalFrame::ResetClipRegion ( )
pure virtual
virtual void SalFrame::SetAlwaysOnTop ( bool  bOnTop)
pure virtual
virtual void SalFrame::SetApplicationID ( const OUString &  rApplicationID)
pure virtual
void SalFrame::SetCallback ( vcl::Window pWindow,
SALFRAMEPROC  pProc 
)

Definition at line 88 of file salvtables.cxx.

References m_pProc, and m_pWindow.

Referenced by vcl::Window::ImplInit().

virtual void SalFrame::SetExtendedFrameStyle ( SalExtStyle  nExtStyle)
pure virtual
virtual void SalFrame::SetIcon ( sal_uInt16  nIcon)
pure virtual
virtual void SalFrame::SetInputContext ( SalInputContext pContext)
pure virtual
virtual void SalFrame::SetMaxClientSize ( long  nWidth,
long  nHeight 
)
pure virtual
virtual void SalFrame::SetMenu ( SalMenu pSalMenu)
pure virtual
virtual void SalFrame::SetMinClientSize ( long  nWidth,
long  nHeight 
)
pure virtual
virtual void SalFrame::SetModal ( bool  )
inlinevirtual

Reimplemented in GtkSalFrame, and Qt5Frame.

Definition at line 250 of file salframe.hxx.

Referenced by Dialog::SetModalInputMode().

void SalFrame::SetModalHierarchyHdl ( const Link< bool, void > &  rLink)
inline

Definition at line 292 of file salframe.hxx.

Referenced by vcl::Window::SetModalHierarchyHdl().

virtual void SalFrame::SetParent ( SalFrame pNewParent)
pure virtual
virtual bool SalFrame::SetPluginParent ( SystemParentData pNewParent)
pure virtual
virtual void SalFrame::SetPointer ( PointerStyle  ePointerStyle)
pure virtual
virtual void SalFrame::SetPointerPos ( long  nX,
long  nY 
)
pure virtual
virtual void SalFrame::SetPosSize ( long  nX,
long  nY,
long  nWidth,
long  nHeight,
sal_uInt16  nFlags 
)
pure virtual
void SalFrame::SetRepresentedURL ( const OUString &  )
virtual

Reimplemented in AquaSalFrame.

Definition at line 101 of file salvtables.cxx.

virtual void SalFrame::SetScreenNumber ( unsigned int  nScreen)
pure virtual
virtual void SalFrame::SetTitle ( const OUString &  rTitle)
pure virtual
virtual void SalFrame::SetWindowState ( const SalFrameState pState)
pure virtual
virtual void SalFrame::Show ( bool  bVisible,
bool  bNoActivate = false 
)
pure virtual
virtual void SalFrame::ShowFullScreen ( bool  bFullScreen,
sal_Int32  nDisplay 
)
pure virtual
virtual void* SalFrame::ShowPopover ( const OUString &  ,
vcl::Window ,
const tools::Rectangle ,
QuickHelpFlags   
)
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 266 of file salframe.hxx.

Referenced by Help::ShowPopover().

virtual bool SalFrame::ShowTooltip ( const OUString &  ,
const tools::Rectangle  
)
inlinevirtual

Reimplemented in GtkSalFrame, and Qt5Frame.

Definition at line 260 of file salframe.hxx.

Referenced by ImplShowHelpWindow().

virtual void SalFrame::SimulateKeyPress ( sal_uInt16  nKeyCode)
pure virtual
virtual void SalFrame::StartPresentation ( bool  bStart)
pure virtual
virtual void SalFrame::ToTop ( SalFrameToTop  nFlags)
pure virtual
virtual void SalFrame::UnionClipRegion ( long  nX,
long  nY,
long  nWidth,
long  nHeight 
)
pure virtual
virtual bool SalFrame::UpdatePopover ( void ,
const OUString &  ,
vcl::Window ,
const tools::Rectangle  
)
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 272 of file salframe.hxx.

Referenced by Help::UpdatePopover().

virtual void SalFrame::UpdateSettings ( AllSettings rSettings)
pure virtual

Member Data Documentation

Link<bool, void> SalFrame::m_aModalHierarchyHdl
private

Definition at line 120 of file salframe.hxx.

SALFRAMEPROC SalFrame::m_pProc
private

Definition at line 119 of file salframe.hxx.

Referenced by SetCallback().

VclPtr<vcl::Window> SalFrame::m_pWindow
private

Definition at line 118 of file salframe.hxx.

Referenced by SetCallback().

std::unique_ptr<weld::Window> SalFrame::m_xFrameWeld
mutableprotected

Definition at line 122 of file salframe.hxx.

Referenced by GetFrameWeld().

SalFrameGeometry SalFrame::maGeometry = {}

absolute, unmirrored values

Definition at line 127 of file salframe.hxx.

Referenced by GtkSalFrame::GetDisplayScreen(), GetGeometry(), Menu::ImplCalcSize(), and ImplWindowFrameProc().


The documentation for this class was generated from the following files: