LibreOffice Module framework (master) 1
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
framework::ComplexToolbarController Class Referenceabstract

#include <complextoolbarcontroller.hxx>

Inheritance diagram for framework::ComplexToolbarController:
[legend]
Collaboration diagram for framework::ComplexToolbarController:
[legend]

Classes

struct  ExecuteInfo
 
struct  NotifyInfo
 

Public Member Functions

 ComplexToolbarController (const css::uno::Reference< css::uno::XComponentContext > &rxContext, const css::uno::Reference< css::frame::XFrame > &rFrame, ToolBox *pToolBar, ToolBoxItemId nID, const OUString &aCommand)
 
virtual ~ComplexToolbarController () override
 
virtual void SAL_CALL dispose () override
 
virtual void SAL_CALL execute (sal_Int16 KeyModifier) override
 
virtual void SAL_CALL statusChanged (const css::frame::FeatureStateEvent &Event) override
 
 DECL_STATIC_LINK (ComplexToolbarController, ExecuteHdl_Impl, void *, void)
 
 DECL_STATIC_LINK (ComplexToolbarController, Notify_Impl, void *, void)
 
- Public Member Functions inherited from svt::ToolboxController
 ToolboxController (const css::uno::Reference< css::uno::XComponentContext > &rxContext, const css::uno::Reference< css::frame::XFrame > &xFrame, OUString aCommandURL)
 
 ToolboxController ()
 
virtual ~ToolboxController () override
 
css::uno::Reference< css::frame::XFrame > getFrameInterface () const
 
const css::uno::Reference< css::uno::XComponentContext > & getContext () const
 
css::uno::Reference< css::frame::XLayoutManager > getLayoutManager () const
 
void updateStatus (const OUString &aCommandURL)
 
void updateStatus ()
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &aType) override
 
virtual void SAL_CALL acquire () noexcept override
 
virtual void SAL_CALL release () noexcept override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 
virtual void SAL_CALL initialize (const css::uno::Sequence< css::uno::Any > &aArguments) override
 
virtual void SAL_CALL update () override
 
virtual void SAL_CALL dispose () override
 
virtual void SAL_CALL addEventListener (const css::uno::Reference< css::lang::XEventListener > &xListener) override
 
virtual void SAL_CALL removeEventListener (const css::uno::Reference< css::lang::XEventListener > &aListener) override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &Source) override
 
virtual void SAL_CALL statusChanged (const css::frame::FeatureStateEvent &Event) override=0
 
virtual void SAL_CALL execute (sal_Int16 KeyModifier) override
 
virtual void SAL_CALL click () override
 
virtual void SAL_CALL doubleClick () override
 
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createPopupWindow () override
 
virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createItemWindow (const css::uno::Reference< css::awt::XWindow > &Parent) override
 
virtual void SAL_CALL setFastPropertyValue_NoBroadcast (sal_Int32 nHandle, const css::uno::Any &rValue) override
 
virtual sal_Bool SAL_CALL convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue) override
 
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
virtual ::cppu::IPropertyArrayHelper &SAL_CALL getInfoHelper () override
 
virtual ::cppu::IPropertyArrayHelper * createArrayHelper () const override
 
const OUString & getCommandURL () const
 
const OUString & getModuleName () const
 
void dispatchCommand (const OUString &sCommandURL, const css::uno::Sequence< css::beans::PropertyValue > &rArgs, const OUString &rTarget=OUString())
 
void enable (bool bEnable)
 
bool IsInSidebar () const
 

Protected Member Functions

css::uno::Reference< css::frame::XDispatch > getDispatchFromCommand (const OUString &aCommand) const
 
void addNotifyInfo (const OUString &aEventName, const css::uno::Reference< css::frame::XDispatch > &xDispatch, const css::uno::Sequence< css::beans::NamedValue > &rInfo)
 
virtual void executeControlCommand (const css::frame::ControlCommand &rControlCommand)=0
 
virtual css::uno::Sequence< css::beans::PropertyValue > getExecuteArgs (sal_Int16 KeyModifier) const
 
const css::util::URL & getInitializedURL ()
 
void notifyFocusGet ()
 
void notifyFocusLost ()
 
void notifyTextChanged (const OUString &aText)
 
- Protected Member Functions inherited from svt::ToolboxController
bool getToolboxId (ToolBoxItemId &rItemId, ToolBox **ppToolBox)
 
 DECL_DLLPRIVATE_STATIC_LINK (ToolboxController, ExecuteHdl_Impl, void *, void)
 
void addStatusListener (const OUString &aCommandURL)
 
void removeStatusListener (const OUString &aCommandURL)
 
void bindListener ()
 
void unbindListener ()
 
const css::uno::Reference< css::util::XURLTransformer > & getURLTransformer () const
 
const css::uno::Reference< css::awt::XWindow > & getParent () const
 

Protected Attributes

VclPtr< ToolBox > m_xToolbar
 
ToolBoxItemId m_nID
 
bool m_bMadeInvisible
 
css::util::URL m_aURL
 
css::uno::Reference< css::util::XURLTransformer > m_xURLTransformer
 
- Protected Attributes inherited from svt::ToolboxController
bool m_bInitialized
 
bool m_bDisposed
 
bool m_bSidebar
 
ToolBoxItemId m_nToolBoxId
 
css::uno::Reference< css::frame::XFrame > m_xFrame
 
css::uno::Reference< css::uno::XComponentContext > m_xContext
 
OUString m_aCommandURL
 
URLToDispatchMap m_aListenerMap
 
comphelper::OMultiTypeInterfaceContainerHelper2 m_aListenerContainer
 
css::uno::Reference< css::awt::XWindow > m_xParentWindow
 
css::uno::Reference< css::util::XURLTransformer > m_xUrlTransformer
 
OUString m_sModuleName
 
weld::Toolbar * m_pToolbar
 
weld::Builder * m_pBuilder
 

Additional Inherited Members

- Protected Types inherited from svt::ToolboxController
typedef std::unordered_map< OUString, css::uno::Reference< css::frame::XDispatch > > URLToDispatchMap
 

Detailed Description

Definition at line 37 of file complextoolbarcontroller.hxx.

Constructor & Destructor Documentation

◆ ComplexToolbarController()

framework::ComplexToolbarController::ComplexToolbarController ( const css::uno::Reference< css::uno::XComponentContext > &  rxContext,
const css::uno::Reference< css::frame::XFrame > &  rFrame,
ToolBox *  pToolBar,
ToolBoxItemId  nID,
const OUString &  aCommand 
)

Definition at line 49 of file complextoolbarcontroller.cxx.

References svt::ToolboxController::m_xContext, and m_xURLTransformer.

◆ ~ComplexToolbarController()

framework::ComplexToolbarController::~ComplexToolbarController ( )
overridevirtual

Definition at line 63 of file complextoolbarcontroller.cxx.

Member Function Documentation

◆ addNotifyInfo()

void framework::ComplexToolbarController::addNotifyInfo ( const OUString &  aEventName,
const css::uno::Reference< css::frame::XDispatch > &  xDispatch,
const css::uno::Sequence< css::beans::NamedValue > &  rInfo 
)
protected

Definition at line 244 of file complextoolbarcontroller.cxx.

References framework::ComplexToolbarController::NotifyInfo::aEventName, framework::ComplexToolbarController::NotifyInfo::aInfoSeq, framework::ComplexToolbarController::NotifyInfo::aSourceURL, svt::ToolboxController::getFrameInterface(), getInitializedURL(), LINK, nCount, Application::PostUserEvent(), xDispatch, and framework::ComplexToolbarController::NotifyInfo::xNotifyListener.

Referenced by framework::ComboboxToolbarController::executeControlCommand(), framework::DropdownToolbarController::executeControlCommand(), framework::ImageButtonToolbarController::executeControlCommand(), framework::ToggleButtonToolbarController::executeControlCommand(), notifyFocusGet(), notifyFocusLost(), and notifyTextChanged().

◆ DECL_STATIC_LINK() [1/2]

framework::ComplexToolbarController::DECL_STATIC_LINK ( ComplexToolbarController  ,
ExecuteHdl_Impl  ,
void *  ,
void   
)

◆ DECL_STATIC_LINK() [2/2]

framework::ComplexToolbarController::DECL_STATIC_LINK ( ComplexToolbarController  ,
Notify_Impl  ,
void *  ,
void   
)

◆ dispose()

void SAL_CALL framework::ComplexToolbarController::dispose ( void  )
overridevirtual

Reimplemented from svt::ToolboxController.

Reimplemented in framework::ComboboxToolbarController, framework::DropdownToolbarController, framework::EditToolbarController, framework::FixedImageToolbarController, framework::FixedTextToolbarController, framework::ImageButtonToolbarController, framework::SpinfieldToolbarController, and framework::ToggleButtonToolbarController.

Definition at line 67 of file complextoolbarcontroller.cxx.

References VclPtr< class reference_type >::clear(), svt::ToolboxController::dispose(), m_nID, m_xToolbar, and m_xURLTransformer.

Referenced by framework::ComboboxToolbarController::dispose(), framework::DropdownToolbarController::dispose(), framework::EditToolbarController::dispose(), framework::FixedImageToolbarController::dispose(), framework::FixedTextToolbarController::dispose(), framework::ImageButtonToolbarController::dispose(), framework::SpinfieldToolbarController::dispose(), and framework::ToggleButtonToolbarController::dispose().

◆ execute()

void SAL_CALL framework::ComplexToolbarController::execute ( sal_Int16  KeyModifier)
overridevirtual

Reimplemented from svt::ToolboxController.

Definition at line 86 of file complextoolbarcontroller.cxx.

References framework::ComplexToolbarController::ExecuteInfo::aArgs, framework::ComplexToolbarController::ExecuteInfo::aTargetURL, aTargetURL, getDispatchFromCommand(), getExecuteArgs(), getInitializedURL(), LINK, svt::ToolboxController::m_aCommandURL, svt::ToolboxController::m_bDisposed, svt::ToolboxController::m_bInitialized, svt::ToolboxController::m_xFrame, m_xURLTransformer, Application::PostUserEvent(), xDispatch, and framework::ComplexToolbarController::ExecuteInfo::xDispatch.

Referenced by framework::ComboboxToolbarController::Activate(), framework::EditToolbarController::Activate(), framework::SpinfieldToolbarController::Activate(), framework::ComboboxToolbarController::Select(), and framework::DropdownToolbarController::Select().

◆ executeControlCommand()

virtual void framework::ComplexToolbarController::executeControlCommand ( const css::frame::ControlCommand &  rControlCommand)
protectedpure virtual

Implemented in framework::ComboboxToolbarController, framework::DropdownToolbarController, framework::EditToolbarController, framework::FixedImageToolbarController, framework::FixedTextToolbarController, framework::ImageButtonToolbarController, framework::SpinfieldToolbarController, and framework::ToggleButtonToolbarController.

Referenced by statusChanged().

◆ getDispatchFromCommand()

uno::Reference< frame::XDispatch > framework::ComplexToolbarController::getDispatchFromCommand ( const OUString &  aCommand) const
protected

Definition at line 273 of file complextoolbarcontroller.cxx.

References aCommand, svt::ToolboxController::m_aListenerMap, svt::ToolboxController::m_bInitialized, svt::ToolboxController::m_xFrame, and xDispatch.

Referenced by execute(), framework::ComboboxToolbarController::executeControlCommand(), framework::DropdownToolbarController::executeControlCommand(), framework::ImageButtonToolbarController::executeControlCommand(), framework::ToggleButtonToolbarController::executeControlCommand(), notifyFocusGet(), notifyFocusLost(), and notifyTextChanged().

◆ getExecuteArgs()

Sequence< PropertyValue > framework::ComplexToolbarController::getExecuteArgs ( sal_Int16  KeyModifier) const
protectedvirtual

Reimplemented in framework::ComboboxToolbarController, framework::DropdownToolbarController, framework::EditToolbarController, framework::FixedTextToolbarController, framework::SpinfieldToolbarController, and framework::ToggleButtonToolbarController.

Definition at line 79 of file complextoolbarcontroller.cxx.

References comphelper::makePropertyValue().

Referenced by execute().

◆ getInitializedURL()

const css::util::URL & framework::ComplexToolbarController::getInitializedURL ( )
protected

Definition at line 287 of file complextoolbarcontroller.cxx.

References svt::ToolboxController::m_aCommandURL, m_aURL, and m_xURLTransformer.

Referenced by addNotifyInfo(), and execute().

◆ notifyFocusGet()

void framework::ComplexToolbarController::notifyFocusGet ( )
protected

Definition at line 297 of file complextoolbarcontroller.cxx.

References addNotifyInfo(), getDispatchFromCommand(), and svt::ToolboxController::m_aCommandURL.

Referenced by framework::ComboboxToolbarController::GetFocus(), framework::DropdownToolbarController::GetFocus(), framework::EditToolbarController::GetFocus(), and framework::SpinfieldToolbarController::GetFocus().

◆ notifyFocusLost()

void framework::ComplexToolbarController::notifyFocusLost ( )
protected

Definition at line 306 of file complextoolbarcontroller.cxx.

References addNotifyInfo(), getDispatchFromCommand(), and svt::ToolboxController::m_aCommandURL.

Referenced by framework::ComboboxToolbarController::LoseFocus(), framework::DropdownToolbarController::LoseFocus(), framework::EditToolbarController::LoseFocus(), and framework::SpinfieldToolbarController::LoseFocus().

◆ notifyTextChanged()

void framework::ComplexToolbarController::notifyTextChanged ( const OUString &  aText)
protected

Definition at line 315 of file complextoolbarcontroller.cxx.

References addNotifyInfo(), getDispatchFromCommand(), and svt::ToolboxController::m_aCommandURL.

Referenced by framework::ComboboxToolbarController::executeControlCommand(), framework::EditToolbarController::executeControlCommand(), framework::FixedTextToolbarController::executeControlCommand(), framework::ComboboxToolbarController::Modify(), framework::EditToolbarController::Modify(), and framework::SpinfieldToolbarController::Modify().

◆ statusChanged()

void framework::ComplexToolbarController::statusChanged ( const css::frame::FeatureStateEvent &  Event)
overridevirtual

Implements svt::ToolboxController.

Definition at line 121 of file complextoolbarcontroller.cxx.

References MnemonicGenerator::EraseAllMnemonicChars(), executeControlCommand(), svt::ToolboxController::m_bDisposed, m_bMadeInvisible, m_nID, m_xToolbar, TRISTATE_FALSE, TRISTATE_INDET, and TRISTATE_TRUE.

Member Data Documentation

◆ m_aURL

css::util::URL framework::ComplexToolbarController::m_aURL
mutableprotected

Definition at line 91 of file complextoolbarcontroller.hxx.

Referenced by getInitializedURL().

◆ m_bMadeInvisible

bool framework::ComplexToolbarController::m_bMadeInvisible
protected

Definition at line 90 of file complextoolbarcontroller.hxx.

Referenced by statusChanged().

◆ m_nID

ToolBoxItemId framework::ComplexToolbarController::m_nID
protected

Definition at line 89 of file complextoolbarcontroller.hxx.

Referenced by framework::ComboboxToolbarController::ComboboxToolbarController(), framework::ToggleButtonToolbarController::createPopupWindow(), framework::ComboboxToolbarController::dispose(), dispose(), framework::DropdownToolbarController::dispose(), framework::EditToolbarController::dispose(), framework::FixedImageToolbarController::dispose(), framework::FixedTextToolbarController::dispose(), framework::SpinfieldToolbarController::dispose(), framework::DropdownToolbarController::DropdownToolbarController(), framework::EditToolbarController::EditToolbarController(), framework::ImageButtonToolbarController::executeControlCommand(), framework::FixedImageToolbarController::FixedImageToolbarController(), framework::FixedTextToolbarController::FixedTextToolbarController(), framework::ImageButtonToolbarController::ImageButtonToolbarController(), framework::SpinfieldToolbarController::SpinfieldToolbarController(), statusChanged(), and framework::ToggleButtonToolbarController::ToggleButtonToolbarController().

◆ m_xToolbar

VclPtr<ToolBox> framework::ComplexToolbarController::m_xToolbar
protected

Definition at line 88 of file complextoolbarcontroller.hxx.

Referenced by framework::ComboboxToolbarController::ComboboxToolbarController(), framework::ToggleButtonToolbarController::createPopupWindow(), framework::ComboboxToolbarController::dispose(), dispose(), framework::DropdownToolbarController::dispose(), framework::EditToolbarController::dispose(), framework::FixedImageToolbarController::dispose(), framework::FixedTextToolbarController::dispose(), framework::SpinfieldToolbarController::dispose(), framework::DropdownToolbarController::DropdownToolbarController(), framework::EditToolbarController::EditToolbarController(), framework::ImageButtonToolbarController::executeControlCommand(), framework::FixedImageToolbarController::FixedImageToolbarController(), framework::FixedTextToolbarController::FixedTextToolbarController(), framework::ImageButtonToolbarController::ImageButtonToolbarController(), framework::SpinfieldToolbarController::SpinfieldToolbarController(), statusChanged(), and framework::ToggleButtonToolbarController::ToggleButtonToolbarController().

◆ m_xURLTransformer

css::uno::Reference< css::util::XURLTransformer > framework::ComplexToolbarController::m_xURLTransformer
protected

Definition at line 92 of file complextoolbarcontroller.hxx.

Referenced by ComplexToolbarController(), dispose(), execute(), and getInitializedURL().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:33:39 for LibreOffice Module framework (master) by doxygen 1.9.3