LibreOffice Module vcl (master)  1
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
JSInstanceBuilder Class Referencefinal

#include <jsdialogbuilder.hxx>

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

Public Member Functions

 JSInstanceBuilder (weld::Widget *pParent, const OUString &rUIRoot, const OUString &rUIFile, bool bPopup=false)
 used for dialogs or popups More...
 
 JSInstanceBuilder (weld::Widget *pParent, const OUString &rUIRoot, const OUString &rUIFile, sal_uInt64 nLOKWindowId)
 used for sidebar panels More...
 
 JSInstanceBuilder (vcl::Window *pParent, const OUString &rUIRoot, const OUString &rUIFile, const css::uno::Reference< css::frame::XFrame > &rFrame, sal_uInt64 nWindowId=0)
 used for notebookbar, optional nWindowId is used if getting parent id failed More...
 
 JSInstanceBuilder (vcl::Window *pParent, const OUString &rUIRoot, const OUString &rUIFile, sal_uInt64 nLOKWindowId)
 used for formulabar More...
 
virtual ~JSInstanceBuilder () override
 
virtual std::unique_ptr< weld::MessageDialog > weld_message_dialog (const OString &id) override
 
virtual std::unique_ptr< weld::Dialog > weld_dialog (const OString &id) override
 
virtual std::unique_ptr< weld::Container > weld_container (const OString &id) override
 
virtual std::unique_ptr< weld::Label > weld_label (const OString &id) override
 
virtual std::unique_ptr< weld::Button > weld_button (const OString &id) override
 
virtual std::unique_ptr< weld::Entry > weld_entry (const OString &id) override
 
virtual std::unique_ptr< weld::ComboBox > weld_combo_box (const OString &id) override
 
virtual std::unique_ptr< weld::Notebook > weld_notebook (const OString &id) override
 
virtual std::unique_ptr< weld::SpinButton > weld_spin_button (const OString &id) override
 
virtual std::unique_ptr< weld::CheckButton > weld_check_button (const OString &id) override
 
virtual std::unique_ptr< weld::DrawingArea > weld_drawing_area (const OString &id, const a11yref &rA11yImpl=nullptr, FactoryFunction pUITestFactoryFunction=nullptr, void *pUserData=nullptr) override
 
virtual std::unique_ptr< weld::Toolbar > weld_toolbar (const OString &id) override
 
virtual std::unique_ptr< weld::TextView > weld_text_view (const OString &id) override
 
virtual std::unique_ptr< weld::TreeView > weld_tree_view (const OString &id) override
 
virtual std::unique_ptr< weld::Expander > weld_expander (const OString &id) override
 
virtual std::unique_ptr< weld::IconView > weld_icon_view (const OString &id) override
 
virtual std::unique_ptr< weld::RadioButton > weld_radio_button (const OString &id) override
 
virtual std::unique_ptr< weld::Frame > weld_frame (const OString &id) override
 
virtual std::unique_ptr< weld::MenuButton > weld_menu_button (const OString &id) override
 
virtual std::unique_ptr< weld::Popover > weld_popover (const OString &id) override
 
virtual std::unique_ptr< weld::Box > weld_box (const OString &id) override
 
virtual std::unique_ptr< weld::Widget > weld_widget (const OString &id) override
 
virtual std::unique_ptr< weld::Image > weld_image (const OString &id) override
 
- Public Member Functions inherited from SalInstanceBuilder
 SalInstanceBuilder (vcl::Window *pParent, const OUString &rUIRoot, const OUString &rUIFile, const css::uno::Reference< css::frame::XFrame > &rFrame=css::uno::Reference< css::frame::XFrame >())
 
virtual std::unique_ptr< weld::Assistant > weld_assistant (const OString &id) override
 
virtual std::unique_ptr< weld::Window > create_screenshot_window () override
 
virtual std::unique_ptr< weld::Paned > weld_paned (const OString &id) override
 
virtual std::unique_ptr< weld::ScrolledWindow > weld_scrolled_window (const OString &id, bool bUserManagedScrolling=false) override
 
virtual std::unique_ptr< weld::MenuToggleButton > weld_menu_toggle_button (const OString &id) override
 
virtual std::unique_ptr< weld::LinkButton > weld_link_button (const OString &id) override
 
virtual std::unique_ptr< weld::ToggleButton > weld_toggle_button (const OString &id) override
 
virtual std::unique_ptr< weld::Scale > weld_scale (const OString &id) override
 
virtual std::unique_ptr< weld::ProgressBar > weld_progress_bar (const OString &id) override
 
virtual std::unique_ptr< weld::Spinner > weld_spinner (const OString &id) override
 
virtual std::unique_ptr< weld::Calendar > weld_calendar (const OString &id) override
 
virtual std::unique_ptr< weld::MetricSpinButton > weld_metric_spin_button (const OString &id, FieldUnit eUnit) override
 
virtual std::unique_ptr< weld::FormattedSpinButton > weld_formatted_spin_button (const OString &id) override
 
virtual std::unique_ptr< weld::EntryTreeView > weld_entry_tree_view (const OString &containerid, const OString &entryid, const OString &treeviewid) override
 
virtual std::unique_ptr< weld::Menu > weld_menu (const OString &id) override
 
virtual std::unique_ptr< weld::SizeGroup > create_size_group () override
 
OString get_current_page_help_id () const
 
virtual ~SalInstanceBuilder () override
 
- Public Member Functions inherited from weld::Builder
virtual ~Builder ()
 
- Public Member Functions inherited from JSDialogSender
 JSDialogSender ()
 
 JSDialogSender (VclPtr< vcl::Window > aNotifierWindow, VclPtr< vcl::Window > aContentWindow, std::string sTypeOfJSON)
 
virtual ~JSDialogSender () COVERITY_NOEXCEPT_FALSE
 
virtual void sendFullUpdate (bool bForce=false)
 
void sendClose ()
 
void sendUpdate (VclPtr< vcl::Window > pWindow, bool bForce=false)
 
virtual void sendAction (VclPtr< vcl::Window > pWindow, std::unique_ptr< jsdialog::ActionDataMap > pData)
 
virtual void sendPopup (VclPtr< vcl::Window > pWindow, OUString sParentId, OUString sCloseId)
 
virtual void sendClosePopup (vcl::LOKWindowId nWindowId)
 
void flush ()
 

Static Public Member Functions

static std::unique_ptr< JSInstanceBuilder > CreateDialogBuilder (weld::Widget *pParent, const OUString &rUIRoot, const OUString &rUIFile)
 
static std::unique_ptr< JSInstanceBuilder > CreateNotebookbarBuilder (vcl::Window *pParent, const OUString &rUIRoot, const OUString &rUIFile, const css::uno::Reference< css::frame::XFrame > &rFrame, sal_uInt64 nWindowId=0)
 
static std::unique_ptr< JSInstanceBuilder > CreateSidebarBuilder (weld::Widget *pParent, const OUString &rUIRoot, const OUString &rUIFile, sal_uInt64 nLOKWindowId=0)
 
static std::unique_ptr< JSInstanceBuilder > CreatePopupBuilder (weld::Widget *pParent, const OUString &rUIRoot, const OUString &rUIFile)
 
static std::unique_ptr< JSInstanceBuilder > CreateFormulabarBuilder (vcl::Window *pParent, const OUString &rUIRoot, const OUString &rUIFile, sal_uInt64 nLOKWindowId)
 
static weld::MessageDialog * CreateMessageDialog (weld::Widget *pParent, VclMessageType eMessageType, VclButtonsType eButtonType, const OUString &rPrimaryMessage)
 
static void AddChildWidget (const std::string &nWindowId, const OString &id, weld::Widget *pWidget)
 
static void RemoveWindowWidget (const std::string &nWindowId)
 

Private Member Functions

void RememberWidget (OString id, weld::Widget *pWidget)
 
std::string getMapIdFromWindowId () const
 
const std::string & GetTypeOfJSON () const
 
VclPtr< vcl::Window > & GetContentWindow ()
 
VclPtr< vcl::Window > & GetNotifierWindow ()
 

Static Private Member Functions

static std::map< std::string, WidgetMap > & GetLOKWeldWidgetsMap ()
 
static void InsertWindowToMap (const std::string &nWindowId)
 
static void RememberWidget (const std::string &nWindowId, const OString &id, weld::Widget *pWidget)
 
static weld::Widget * FindWeldWidgetsMap (const std::string &nWindowId, const OString &rWidget)
 

Private Attributes

sal_uInt64 m_nWindowId
 
VclPtr< vcl::Window > m_aParentDialog
 used in case of tab pages where dialog is not a direct top level More...
 
VclPtr< vcl::Window > m_aContentWindow
 
std::list< std::string > m_aRememberedWidgets
 
std::string m_sTypeOfJSON
 
bool m_bHasTopLevelDialog
 
bool m_bIsNotebookbar
 
VclPtr< vcl::Window > m_aWindowToRelease
 When LOKNotifier is set by jsdialogs code we need to release it. More...
 

Friends

VCL_DLLPUBLIC bool jsdialog::ExecuteAction (const std::string &nWindowId, const OString &rWidget, StringMap &rData)
 
VCL_DLLPUBLIC void jsdialog::SendFullUpdate (const std::string &nWindowId, const OString &rWidget)
 
VCL_DLLPUBLIC void jsdialog::SendAction (const std::string &nWindowId, const OString &rWidget, std::unique_ptr< jsdialog::ActionDataMap > pData)
 

Additional Inherited Members

- Protected Member Functions inherited from JSDialogSender
void initializeSender (VclPtr< vcl::Window > aNotifierWindow, VclPtr< vcl::Window > aContentWindow, std::string sTypeOfJSON)
 
- Protected Attributes inherited from SalInstanceBuilder
std::unique_ptr< VclBuilder > m_xBuilder
 
VclPtr< vcl::Window > m_aOwnedToplevel
 
- Protected Attributes inherited from JSDialogSender
bool m_bCanClose
 

Detailed Description

Definition at line 208 of file jsdialogbuilder.hxx.

Constructor & Destructor Documentation

JSInstanceBuilder::JSInstanceBuilder ( weld::Widget *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
bool  bPopup = false 
)

used for dialogs or popups

JSInstanceBuilder::JSInstanceBuilder ( weld::Widget *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
sal_uInt64  nLOKWindowId 
)

used for sidebar panels

JSInstanceBuilder::JSInstanceBuilder ( vcl::Window *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
const css::uno::Reference< css::frame::XFrame > &  rFrame,
sal_uInt64  nWindowId = 0 
)

used for notebookbar, optional nWindowId is used if getting parent id failed

JSInstanceBuilder::JSInstanceBuilder ( vcl::Window *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
sal_uInt64  nLOKWindowId 
)

used for formulabar

virtual JSInstanceBuilder::~JSInstanceBuilder ( )
overridevirtual

Member Function Documentation

static void JSInstanceBuilder::AddChildWidget ( const std::string &  nWindowId,
const OString &  id,
weld::Widget *  pWidget 
)
static
static std::unique_ptr<JSInstanceBuilder> JSInstanceBuilder::CreateDialogBuilder ( weld::Widget *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile 
)
static

Referenced by Application::CreateBuilder().

static std::unique_ptr<JSInstanceBuilder> JSInstanceBuilder::CreateFormulabarBuilder ( vcl::Window *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
sal_uInt64  nLOKWindowId 
)
static

Referenced by Application::CreateInterimBuilder().

static weld::MessageDialog* JSInstanceBuilder::CreateMessageDialog ( weld::Widget *  pParent,
VclMessageType  eMessageType,
VclButtonsType  eButtonType,
const OUString &  rPrimaryMessage 
)
static

Referenced by Application::CreateMessageDialog().

static std::unique_ptr<JSInstanceBuilder> JSInstanceBuilder::CreateNotebookbarBuilder ( vcl::Window *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
const css::uno::Reference< css::frame::XFrame > &  rFrame,
sal_uInt64  nWindowId = 0 
)
static

Referenced by Application::CreateInterimBuilder().

static std::unique_ptr<JSInstanceBuilder> JSInstanceBuilder::CreatePopupBuilder ( weld::Widget *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile 
)
static

Referenced by Application::CreateBuilder().

static std::unique_ptr<JSInstanceBuilder> JSInstanceBuilder::CreateSidebarBuilder ( weld::Widget *  pParent,
const OUString &  rUIRoot,
const OUString &  rUIFile,
sal_uInt64  nLOKWindowId = 0 
)
static

Referenced by Application::CreateBuilder().

static weld::Widget* JSInstanceBuilder::FindWeldWidgetsMap ( const std::string &  nWindowId,
const OString &  rWidget 
)
staticprivate
VclPtr<vcl::Window>& JSInstanceBuilder::GetContentWindow ( )
private
static std::map<std::string, WidgetMap>& JSInstanceBuilder::GetLOKWeldWidgetsMap ( )
staticprivate
std::string JSInstanceBuilder::getMapIdFromWindowId ( ) const
private
VclPtr<vcl::Window>& JSInstanceBuilder::GetNotifierWindow ( )
private
const std::string& JSInstanceBuilder::GetTypeOfJSON ( ) const
private
static void JSInstanceBuilder::InsertWindowToMap ( const std::string &  nWindowId)
staticprivate
void JSInstanceBuilder::RememberWidget ( OString  id,
weld::Widget *  pWidget 
)
private
static void JSInstanceBuilder::RememberWidget ( const std::string &  nWindowId,
const OString &  id,
weld::Widget *  pWidget 
)
staticprivate
static void JSInstanceBuilder::RemoveWindowWidget ( const std::string &  nWindowId)
static
virtual std::unique_ptr<weld::Box> JSInstanceBuilder::weld_box ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Button> JSInstanceBuilder::weld_button ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::CheckButton> JSInstanceBuilder::weld_check_button ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::ComboBox> JSInstanceBuilder::weld_combo_box ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Container> JSInstanceBuilder::weld_container ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Dialog> JSInstanceBuilder::weld_dialog ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::DrawingArea> JSInstanceBuilder::weld_drawing_area ( const OString &  id,
const a11yref &  rA11yImpl = nullptr,
FactoryFunction  pUITestFactoryFunction = nullptr,
void *  pUserData = nullptr 
)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Entry> JSInstanceBuilder::weld_entry ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Expander> JSInstanceBuilder::weld_expander ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Frame> JSInstanceBuilder::weld_frame ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::IconView> JSInstanceBuilder::weld_icon_view ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Image> JSInstanceBuilder::weld_image ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Label> JSInstanceBuilder::weld_label ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::MenuButton> JSInstanceBuilder::weld_menu_button ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::MessageDialog> JSInstanceBuilder::weld_message_dialog ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Notebook> JSInstanceBuilder::weld_notebook ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Popover> JSInstanceBuilder::weld_popover ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::RadioButton> JSInstanceBuilder::weld_radio_button ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::SpinButton> JSInstanceBuilder::weld_spin_button ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::TextView> JSInstanceBuilder::weld_text_view ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Toolbar> JSInstanceBuilder::weld_toolbar ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::TreeView> JSInstanceBuilder::weld_tree_view ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

virtual std::unique_ptr<weld::Widget> JSInstanceBuilder::weld_widget ( const OString &  id)
overridevirtual

Reimplemented from SalInstanceBuilder.

Friends And Related Function Documentation

VCL_DLLPUBLIC bool jsdialog::ExecuteAction ( const std::string &  nWindowId,
const OString &  rWidget,
StringMap &  rData 
)
friend
VCL_DLLPUBLIC void jsdialog::SendAction ( const std::string &  nWindowId,
const OString &  rWidget,
std::unique_ptr< jsdialog::ActionDataMap >  pData 
)
friend
VCL_DLLPUBLIC void jsdialog::SendFullUpdate ( const std::string &  nWindowId,
const OString &  rWidget 
)
friend

Member Data Documentation

VclPtr<vcl::Window> JSInstanceBuilder::m_aContentWindow
private

Definition at line 213 of file jsdialogbuilder.hxx.

VclPtr<vcl::Window> JSInstanceBuilder::m_aParentDialog
private

used in case of tab pages where dialog is not a direct top level

Definition at line 212 of file jsdialogbuilder.hxx.

std::list<std::string> JSInstanceBuilder::m_aRememberedWidgets
private

Definition at line 214 of file jsdialogbuilder.hxx.

VclPtr<vcl::Window> JSInstanceBuilder::m_aWindowToRelease
private

When LOKNotifier is set by jsdialogs code we need to release it.

Definition at line 219 of file jsdialogbuilder.hxx.

bool JSInstanceBuilder::m_bHasTopLevelDialog
private

Definition at line 216 of file jsdialogbuilder.hxx.

bool JSInstanceBuilder::m_bIsNotebookbar
private

Definition at line 217 of file jsdialogbuilder.hxx.

sal_uInt64 JSInstanceBuilder::m_nWindowId
private

Definition at line 210 of file jsdialogbuilder.hxx.

std::string JSInstanceBuilder::m_sTypeOfJSON
private

Definition at line 215 of file jsdialogbuilder.hxx.

The documentation for this class was generated from the following file:
Generated on Tue May 24 2022 12:33:27 for LibreOffice Module vcl (master) by   doxygen 1.8.10