LibreOffice Module vcl (master) 1
Classes | Public Member Functions | Static 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 tools::Long GetWidth () const override
 
virtual tools::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 SetExtendedFrameStyle (SalExtStyle nExtStyle)=0
 
virtual void Show (bool bVisible, bool bNoActivate=false)=0
 
virtual void SetMinClientSize (tools::Long nWidth, tools::Long nHeight)=0
 
virtual void SetMaxClientSize (tools::Long nWidth, tools::Long nHeight)=0
 
virtual void SetPosSize (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags)=0
 
virtual void GetClientSize (tools::Long &rWidth, tools::Long &rHeight)=0
 
virtual void GetWorkArea (tools::Rectangle &rRect)=0
 
virtual SalFrameGetParent () const =0
 
SalFrameGeometry GetGeometry () const
 
const SalFrameGeometryGetUnmirroredGeometry () const
 
virtual void SetWindowState (const vcl::WindowData *)=0
 
virtual bool GetWindowState (vcl::WindowData *)=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 GrabFocus ()
 
virtual void SetPointer (PointerStyle ePointerStyle)=0
 
virtual void CaptureMouse (bool bMouse)=0
 
virtual void SetPointerPos (tools::Long nX, tools::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 void ResolveWindowHandle (SystemEnvData &) const
 
virtual SalPointerState GetPointerState ()=0
 
virtual KeyIndicatorState GetIndicatorState ()=0
 
virtual void SimulateKeyPress (sal_uInt16 nKeyCode)=0
 
virtual void SetParent (SalFrame *pNewParent)=0
 
virtual void 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 (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight)=0
 
virtual void EndSetClipRegion ()=0
 
virtual void SetModal (bool)
 
virtual bool GetModal () const
 
virtual bool ShowTooltip (const OUString &, const tools::Rectangle &)
 
virtual void * ShowPopover (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 ()
 
virtual tools::Long GetWidth () const =0
 
virtual tools::Long GetHeight () const =0
 
virtual bool IsOffScreen () const =0
 

Static Public Member Functions

static OUString DumpSetPosSize (tools::Long nX, tools::Long nY, tools::Long nWidth, tools::Long nHeight, sal_uInt16 nFlags)
 
static Selection CalcDeleteSurroundingSelection (const OUString &rSurroundingText, sal_Int32 nCursorIndex, int nOffset, int nChars)
 

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, void > m_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::SalFrame ( )

Definition at line 88 of file salvtables.cxx.

◆ ~SalFrame()

SalFrame::~SalFrame ( )
overridevirtual

Definition at line 97 of file salvtables.cxx.

Member Function Documentation

◆ AcquireGraphics()

virtual SalGraphics * SalFrame::AcquireGraphics ( )
pure virtual

◆ Beep()

virtual void SalFrame::Beep ( )
pure virtual

◆ BeginSetClipRegion()

virtual void SalFrame::BeginSetClipRegion ( sal_uInt32  nRects)
pure virtual

◆ CalcDeleteSurroundingSelection()

Selection SalFrame::CalcDeleteSurroundingSelection ( const OUString &  rSurroundingText,
sal_Int32  nCursorIndex,
int  nOffset,
int  nChars 
)
static

Definition at line 7591 of file salvtables.cxx.

References nCount, SAL_MAX_UINT32, and SAL_WARN.

◆ CallCallback()

bool SalFrame::CallCallback ( SalEvent  nEvent,
const void *  pEvent 
) const
inline

Definition at line 305 of file salframe.hxx.

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

◆ CaptureMouse()

virtual void SalFrame::CaptureMouse ( bool  bMouse)
pure virtual

◆ DumpSetPosSize()

OUString SalFrame::DumpSetPosSize ( tools::Long  nX,
tools::Long  nY,
tools::Long  nWidth,
tools::Long  nHeight,
sal_uInt16  nFlags 
)
static

◆ EndExtTextInput()

virtual void SalFrame::EndExtTextInput ( EndExtTextInputFlags  nFlags)
pure virtual

◆ EndSetClipRegion()

virtual void SalFrame::EndSetClipRegion ( )
pure virtual

◆ Flush() [1/2]

virtual void SalFrame::Flush ( )
pure virtual

◆ Flush() [2/2]

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

Reimplemented in SvpSalFrame, QtFrame, GtkSalFrame, X11SalFrame, WinSalFrame, and AquaSalFrame.

Definition at line 107 of file salvtables.cxx.

References Flush().

◆ GetClientSize()

virtual void SalFrame::GetClientSize ( tools::Long rWidth,
tools::Long rHeight 
)
pure virtual

◆ GetFrameWeld()

weld::Window * SalFrame::GetFrameWeld ( ) const
virtual

Reimplemented in GtkSalFrame.

Definition at line 7577 of file salvtables.cxx.

References vcl::Window::GetFrameWindow(), GetWindow(), and m_xFrameWeld.

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

◆ GetGeometry()

SalFrameGeometry SalFrame::GetGeometry ( ) const

◆ GetHeight()

virtual tools::Long SalFrame::GetHeight ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 131 of file salframe.hxx.

References vcl::WindowPosSize::height().

◆ GetIndicatorState()

virtual KeyIndicatorState SalFrame::GetIndicatorState ( )
pure virtual

◆ GetInputLanguage()

virtual LanguageType SalFrame::GetInputLanguage ( )
pure virtual

◆ GetKeyName()

virtual OUString SalFrame::GetKeyName ( sal_uInt16  nKeyCode)
pure virtual

◆ GetModal()

virtual bool SalFrame::GetModal ( ) const
inlinevirtual

Reimplemented in QtFrame, and GtkSalFrame.

Definition at line 261 of file salframe.hxx.

Referenced by SalInstanceWindow::get_modal().

◆ GetParent()

virtual SalFrame * SalFrame::GetParent ( ) const
pure virtual

◆ GetPointerState()

virtual SalPointerState SalFrame::GetPointerState ( )
pure virtual

◆ GetSystemData()

virtual const SystemEnvData * SalFrame::GetSystemData ( ) const
pure virtual

◆ GetUnmirroredGeometry()

const SalFrameGeometry & SalFrame::GetUnmirroredGeometry ( ) const
inline

Definition at line 165 of file salframe.hxx.

◆ GetWidth()

virtual tools::Long SalFrame::GetWidth ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 130 of file salframe.hxx.

References vcl::WindowPosSize::width().

◆ GetWindow()

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

Definition at line 297 of file salframe.hxx.

Referenced by GetFrameWeld(), and vcl::Window::GetFrameWindow().

◆ GetWindowState()

virtual bool SalFrame::GetWindowState ( vcl::WindowData )
pure virtual

◆ GetWorkArea()

virtual void SalFrame::GetWorkArea ( tools::Rectangle rRect)
pure virtual

◆ GrabFocus()

virtual void SalFrame::GrabFocus ( )
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 184 of file salframe.hxx.

◆ HidePopover()

virtual bool SalFrame::HidePopover ( void *  )
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 285 of file salframe.hxx.

Referenced by Help::HidePopover().

◆ IsOffScreen()

virtual bool SalFrame::IsOffScreen ( ) const
inlineoverridevirtual

Implements SalGeometryProvider.

Definition at line 132 of file salframe.hxx.

◆ MapUnicodeToKeyCode()

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

◆ NotifyModalHierarchy()

void SalFrame::NotifyModalHierarchy ( bool  bModal)
inline

Definition at line 300 of file salframe.hxx.

References Link< typename Arg, typename Ret >::Call().

Referenced by Dialog::SetModalInputMode().

◆ PositionByToolkit()

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

Reimplemented in GtkSalFrame.

Definition at line 173 of file salframe.hxx.

Referenced by FloatingWindow::StartPopupMode().

◆ PostEvent()

virtual bool SalFrame::PostEvent ( std::unique_ptr< ImplSVEvent pData)
pure virtual

◆ ReleaseGraphics()

virtual void SalFrame::ReleaseGraphics ( SalGraphics pGraphics)
pure virtual

◆ ResetClipRegion()

virtual void SalFrame::ResetClipRegion ( )
pure virtual

◆ ResolveWindowHandle()

virtual void SalFrame::ResolveWindowHandle ( SystemEnvData ) const
inlinevirtual

Reimplemented in QtFrame, and GtkSalFrame.

Definition at line 220 of file salframe.hxx.

Referenced by SystemEnvData::GetWindowHandle().

◆ SetAlwaysOnTop()

virtual void SalFrame::SetAlwaysOnTop ( bool  bOnTop)
pure virtual

◆ SetApplicationID()

virtual void SalFrame::SetApplicationID ( const OUString &  rApplicationID)
pure virtual

◆ SetCallback()

void SalFrame::SetCallback ( vcl::Window pWindow,
SALFRAMEPROC  pProc 
)

Definition at line 99 of file salvtables.cxx.

References m_pProc, and m_pWindow.

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

◆ SetExtendedFrameStyle()

virtual void SalFrame::SetExtendedFrameStyle ( SalExtStyle  nExtStyle)
pure virtual

◆ SetIcon()

virtual void SalFrame::SetIcon ( sal_uInt16  nIcon)
pure virtual

◆ SetInputContext()

virtual void SalFrame::SetInputContext ( SalInputContext pContext)
pure virtual

◆ SetMaxClientSize()

virtual void SalFrame::SetMaxClientSize ( tools::Long  nWidth,
tools::Long  nHeight 
)
pure virtual

◆ SetMenu()

virtual void SalFrame::SetMenu ( SalMenu pSalMenu)
pure virtual

◆ SetMinClientSize()

virtual void SalFrame::SetMinClientSize ( tools::Long  nWidth,
tools::Long  nHeight 
)
pure virtual

◆ SetModal()

virtual void SalFrame::SetModal ( bool  )
inlinevirtual

Reimplemented in QtFrame, and GtkSalFrame.

Definition at line 257 of file salframe.hxx.

Referenced by SalInstanceWindow::set_modal(), and Dialog::SetModalInputMode().

◆ SetModalHierarchyHdl()

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

Definition at line 299 of file salframe.hxx.

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

◆ SetParent()

virtual void SalFrame::SetParent ( SalFrame pNewParent)
pure virtual

◆ SetPluginParent()

virtual void SalFrame::SetPluginParent ( SystemParentData pNewParent)
pure virtual

◆ SetPointer()

virtual void SalFrame::SetPointer ( PointerStyle  ePointerStyle)
pure virtual

◆ SetPointerPos()

virtual void SalFrame::SetPointerPos ( tools::Long  nX,
tools::Long  nY 
)
pure virtual

◆ SetPosSize()

virtual void SalFrame::SetPosSize ( tools::Long  nX,
tools::Long  nY,
tools::Long  nWidth,
tools::Long  nHeight,
sal_uInt16  nFlags 
)
pure virtual

◆ SetRepresentedURL()

void SalFrame::SetRepresentedURL ( const OUString &  )
virtual

Reimplemented in AquaSalFrame.

Definition at line 109 of file salvtables.cxx.

◆ SetScreenNumber()

virtual void SalFrame::SetScreenNumber ( unsigned int  nScreen)
pure virtual

◆ SetTitle()

virtual void SalFrame::SetTitle ( const OUString &  rTitle)
pure virtual

◆ SetWindowState()

virtual void SalFrame::SetWindowState ( const vcl::WindowData )
pure virtual

◆ Show()

virtual void SalFrame::Show ( bool  bVisible,
bool  bNoActivate = false 
)
pure virtual

◆ ShowFullScreen()

virtual void SalFrame::ShowFullScreen ( bool  bFullScreen,
sal_Int32  nDisplay 
)
pure virtual

◆ ShowPopover()

virtual void * SalFrame::ShowPopover ( const OUString &  ,
vcl::Window ,
const tools::Rectangle ,
QuickHelpFlags   
)
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 273 of file salframe.hxx.

Referenced by Help::ShowPopover().

◆ ShowTooltip()

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

Reimplemented in GtkSalFrame, and QtFrame.

Definition at line 267 of file salframe.hxx.

Referenced by ImplShowHelpWindow().

◆ SimulateKeyPress()

virtual void SalFrame::SimulateKeyPress ( sal_uInt16  nKeyCode)
pure virtual

◆ StartPresentation()

virtual void SalFrame::StartPresentation ( bool  bStart)
pure virtual

◆ ToTop()

virtual void SalFrame::ToTop ( SalFrameToTop  nFlags)
pure virtual

◆ UnionClipRegion()

virtual void SalFrame::UnionClipRegion ( tools::Long  nX,
tools::Long  nY,
tools::Long  nWidth,
tools::Long  nHeight 
)
pure virtual

◆ UpdatePopover()

virtual bool SalFrame::UpdatePopover ( void *  ,
const OUString &  ,
vcl::Window ,
const tools::Rectangle  
)
inlinevirtual

Reimplemented in GtkSalFrame.

Definition at line 279 of file salframe.hxx.

Referenced by Help::UpdatePopover().

◆ UpdateSettings()

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

Member Data Documentation

◆ m_aModalHierarchyHdl

Link<bool, void> SalFrame::m_aModalHierarchyHdl
private

Definition at line 120 of file salframe.hxx.

◆ m_pProc

SALFRAMEPROC SalFrame::m_pProc
private

Definition at line 119 of file salframe.hxx.

Referenced by SetCallback().

◆ m_pWindow

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

Definition at line 118 of file salframe.hxx.

Referenced by SetCallback().

◆ m_xFrameWeld

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

Definition at line 122 of file salframe.hxx.

Referenced by GetFrameWeld().

◆ maGeometry

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: