fwk142: #i104293 Use Commands.xcu files to mark commands which support a toggle state

5 files changed, 70 insertions, 36 deletions

diff --git a/framework/inc/properties.h b/framework/inc/properties.h
index f0358ef6f1a0..5a32a42a28cc 100644
--- a/framework/inc/properties.h
+++ b/framework/inc/properties.h
@@ -217,6 +217,14 @@ namespace framework{
 #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDROTATEIMAGELIST  "private:resource/image/commandrotateimagelist"
 #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDMIRRORIMAGELIST  "private:resource/image/commandmirrorimagelist"
 
+#define UICOMMANDDESCRIPTION_PROPNAME_PROPERTIES                "Properties"
+#define UICOMMANDDESCRIPTION_PROPNAME_POPUP                     "Popup"
+
+#define UICOMMANDDESCRIPTION_PROPERTIES_IMAGE                   1
+#define UICOMMANDDESCRIPTION_PROPERTIES_IMAGE_MIRRORED          2
+#define UICOMMANDDESCRIPTION_PROPERTIES_IMAGE_ROTATED           4
+#define UICOMMANDDESCRIPTION_PROPERTIES_TOGGLEBUTTON            8
+
 //_______________________________________________
 /** properties for "AutoRecovery" class */
 
diff --git a/framework/inc/uielement/toolbarmanager.hxx b/framework/inc/uielement/toolbarmanager.hxx
index 98894b623aea..1be8579a4112 100644
--- a/framework/inc/uielement/toolbarmanager.hxx
+++ b/framework/inc/uielement/toolbarmanager.hxx
@@ -179,6 +179,8 @@ class ToolBarManager : public ::com::sun::star::frame::XFrameActionListener
 
         void RemoveControllers();
         rtl::OUString RetrieveLabelFromCommand( const rtl::OUString& aCmdURL );
+        sal_Int32 RetrievePropertiesFromCommand( const rtl::OUString& aCmdURL );
+        ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > GetPropsForCommand( const ::rtl::OUString& rCmdURL );
         void CreateControllers();
         void UpdateControllers();
         void AddFrameActionListener();
diff --git a/framework/inc/uielement/uicommanddescription.hxx b/framework/inc/uielement/uicommanddescription.hxx
index d9f8e461c5b5..dd95981bba90 100644
--- a/framework/inc/uielement/uicommanddescription.hxx
+++ b/framework/inc/uielement/uicommanddescription.hxx
@@ -109,7 +109,7 @@ public:
         ModuleToCommandFileMap                                                              m_aModuleToCommandFileMap;
         UICommandsHashMap                                                                   m_aUICommandsHashMap;
         ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >        m_xGenericUICommands;
-        ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModuleManager > m_xModuleManager;
+        ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModuleManager >         m_xModuleManager;
 };
 
 } // namespace framework
diff --git a/framework/source/uielement/toolbarmanager.cxx b/framework/source/uielement/toolbarmanager.cxx
index d89b81c0f9b6..8171ff2e5419 100644
--- a/framework/source/uielement/toolbarmanager.cxx
+++ b/framework/source/uielement/toolbarmanager.cxx
@@ -112,6 +112,7 @@ using namespace ::com::sun::star::util;
 using namespace ::com::sun::star::container;
 using namespace ::com::sun::star::frame;
 using namespace ::com::sun::star::ui;
+using namespace ::com::sun::star;
 
 namespace framework
 {
@@ -803,17 +804,18 @@ void ToolBarManager::RemoveControllers()
     m_aControllerMap.clear();
 }
 
-::rtl::OUString ToolBarManager::RetrieveLabelFromCommand( const ::rtl::OUString& aCmdURL )
+uno::Sequence< beans::PropertyValue > ToolBarManager::GetPropsForCommand( const ::rtl::OUString& rCmdURL )
 {
-    ::rtl::OUString aLabel;
+    Sequence< PropertyValue > aPropSeq;
 
-    // Retrieve popup menu labels
-    if ( !m_bModuleIdentified )
+    // Retrieve properties for command
+    try
     {
-        Reference< XModuleManager > xModuleManager( m_xServiceManager->createInstance( SERVICENAME_MODULEMANAGER ), UNO_QUERY_THROW );
-        Reference< XInterface > xIfac( m_xFrame, UNO_QUERY );
-        try
+        if ( !m_bModuleIdentified )
         {
+            Reference< XModuleManager > xModuleManager( m_xServiceManager->createInstance( SERVICENAME_MODULEMANAGER ), UNO_QUERY_THROW );
+            Reference< XInterface > xIfac( m_xFrame, UNO_QUERY );
+
             m_bModuleIdentified = sal_True;
             m_aModuleIdentifier = xModuleManager->identify( xIfac );
 
@@ -821,44 +823,57 @@ void ToolBarManager::RemoveControllers()
             {
                 Reference< XNameAccess > xNameAccess( m_xServiceManager->createInstance( SERVICENAME_UICOMMANDDESCRIPTION ), UNO_QUERY );
                 if ( xNameAccess.is() )
-                {
                     xNameAccess->getByName( m_aModuleIdentifier ) >>= m_xUICommandLabels;
-                }
             }
         }
-        catch ( Exception& )
+
+        if ( m_xUICommandLabels.is() )
         {
+            if ( rCmdURL.getLength() > 0 )
+                m_xUICommandLabels->getByName( rCmdURL ) >>= aPropSeq;
         }
     }
+    catch ( Exception& )
+    {
+    }
 
-    if ( m_xUICommandLabels.is() )
+    return aPropSeq;
+}
+
+::rtl::OUString ToolBarManager::RetrieveLabelFromCommand( const ::rtl::OUString& aCmdURL )
+{
+    ::rtl::OUString aLabel;
+    Sequence< PropertyValue > aPropSeq;
+
+    // Retrieve popup menu labels
+    aPropSeq = GetPropsForCommand( aCmdURL );
+    for ( sal_Int32 i = 0; i < aPropSeq.getLength(); i++ )
     {
-        try
+        if ( aPropSeq[i].Name.equalsAscii( "Name" ))
         {
-            if ( aCmdURL.getLength() > 0 )
-            {
-                rtl::OUString aStr;
-                Sequence< PropertyValue > aPropSeq;
-                if ( m_xUICommandLabels->getByName( aCmdURL ) >>= aPropSeq )
-                {
-                    for ( sal_Int32 i = 0; i < aPropSeq.getLength(); i++ )
-                    {
-                        if ( aPropSeq[i].Name.equalsAscii( "Name" ))
-                        {
-                            aPropSeq[i].Value >>= aStr;
-                            break;
-                        }
-                    }
-                }
-                aLabel = aStr;
-            }
+            aPropSeq[i].Value >>= aLabel;
+            break;
         }
-        catch ( com::sun::star::uno::Exception& )
+    }
+    return aLabel;
+}
+
+sal_Int32 ToolBarManager::RetrievePropertiesFromCommand( const ::rtl::OUString& aCmdURL )
+{
+    sal_Int32 nProperties(0);
+    Sequence< PropertyValue > aPropSeq;
+
+    // Retrieve popup menu labels
+    aPropSeq = GetPropsForCommand( aCmdURL );
+    for ( sal_Int32 i = 0; i < aPropSeq.getLength(); i++ )
+    {
+        if ( aPropSeq[i].Name.equalsAscii( "Properties" ))
         {
+            aPropSeq[i].Value >>= nProperties;
+            break;
         }
     }
-
-    return aLabel;
+    return nProperties;
 }
 
 void ToolBarManager::CreateControllers()
@@ -969,8 +984,15 @@ void ToolBarManager::CreateControllers()
                 {
                     MenuDescriptionMap::iterator it = m_aMenuMap.find( nId );
                     if ( it == m_aMenuMap.end() )
-                    xController = Reference< XStatusListener >(
-                        new GenericToolbarController( m_xServiceManager, m_xFrame, m_pToolBar, nId, aCommandURL ));
+                    {
+                        xController = Reference< XStatusListener >(
+                            new GenericToolbarController( m_xServiceManager, m_xFrame, m_pToolBar, nId, aCommandURL ));
+
+                        // Accessibility support: Set toggle button role for specific commands
+                        sal_Int32 nProps = RetrievePropertiesFromCommand( aCommandURL );
+                        if ( nProps & UICOMMANDDESCRIPTION_PROPERTIES_TOGGLEBUTTON )
+                            m_pToolBar->SetItemBits( nId, m_pToolBar->GetItemBits( nId ) | TIB_CHECKABLE );
+                    }
                     else
                         xController = Reference< XStatusListener >(
                             new MenuToolbarController( m_xServiceManager, m_xFrame, m_pToolBar, nId, aCommandURL, m_aModuleIdentifier, m_aMenuMap[ nId ] ));
diff --git a/framework/source/uielement/uicommanddescription.cxx b/framework/source/uielement/uicommanddescription.cxx
index fdcd08f221fd..0d50aa4c36d4 100644
--- a/framework/source/uielement/uicommanddescription.cxx
+++ b/framework/source/uielement/uicommanddescription.cxx
@@ -340,7 +340,7 @@ Any ConfigurationAccess_UICommand::getSequenceFromCache( const ::rtl::OUString&
         if ( !pIter->second.bCommandNameCreated )
             fillInfoFromResult( pIter->second, pIter->second.aLabel );
 
-        Sequence< PropertyValue > aPropSeq( 3 );
+        Sequence< PropertyValue > aPropSeq( 4 );
         aPropSeq[0].Name  = m_aPropLabel;
         aPropSeq[0].Value = pIter->second.aContextLabel.getLength() ?
                 makeAny( pIter->second.aContextLabel ): makeAny( pIter->second.aLabel );
@@ -348,6 +348,8 @@ Any ConfigurationAccess_UICommand::getSequenceFromCache( const ::rtl::OUString&
         aPropSeq[1].Value <<= pIter->second.aCommandName;
         aPropSeq[2].Name  = m_aPropPopup;
         aPropSeq[2].Value <<= pIter->second.bPopup;
+        aPropSeq[3].Name  = m_aPropProperties;
+        aPropSeq[3].Value <<= pIter->second.nProperties;
         return makeAny( aPropSeq );
     }