Development/Tutorials/Localization/Language Change - Revision history

AnneW at 14:19, 14 July 2012

2012-07-14T14:19:17Z

Jan: Use correct syntax highlighting (xml and cpp-qt)

2011-08-11T09:36:46Z

Use correct syntax highlighting (xml and cpp-qt)

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:46Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:44:55Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 15:
Line 15:
  Simply modify this file to contain:   Simply modify this file to contain:
    
− <code> + <syntaxhighlight lang="text">
  <Menu name="help">   <Menu name="help">
       <Action name="switch_application_language"/>        <Action name="switch_application_language"/>
Line 35:
Line 35:
  So in your class that inherits from KXmlGuiWindow, add to the header file:   So in your class that inherits from KXmlGuiWindow, add to the header file:
    
− <code> + <syntaxhighlight lang="text">
     class MyWindow {      class MyWindow {
       ...        ...
Line 47:
Line 47:
    
  and to the source file:   and to the source file:
− <code> + <syntaxhighlight lang="text">
  MyWindow::MyWindow() : KXmlGuiWindow( 0 )   MyWindow::MyWindow() : KXmlGuiWindow( 0 )
  {   {



DrSlowDecay: Added language navigation
2007-12-21T14:47:35Z
Added language navigation

				
				
				
				
			
			← Older revision
			Revision as of 14:47, 21 December 2007
			
Line 1:
Line 1:
  + {{Template:I18n/Language Navigation Bar|Development/Tutorials/Localization/Language Change}}
  + 
  {{TutorialBrowser|   {{TutorialBrowser|
  series=Localization|   series=Localization|





JohnFlux at 20:24, 23 October 2007
2007-10-23T20:24:35Z


				
				
				
				
			
			← Older revision
			Revision as of 20:24, 23 October 2007
			
Line 5:
Line 5:
  }}   }}
    
− == Adding option to change the language == + == Adding an option to change the language ==
    
  It can be extremely useful for a user to be able to change the language of a specific application.  It is fortunately extremely easy to add such functionality to your program.   It can be extremely useful for a user to be able to change the language of a specific application.  It is fortunately extremely easy to add such functionality to your program.



JohnFlux at 20:22, 23 October 2007
2007-10-23T20:22:34Z


				
				
				
				
			
			← Older revision
			Revision as of 20:22, 23 October 2007
			
Line 1:
Line 1:
  + {{TutorialBrowser|
  + series=Localization|
  + name=Dealing with Language Changes|
  + pre=[[../i18n|Writing Applications With Localization in Mind]]|
  + }}
  + 
  == Adding option to change the language ==   == Adding option to change the language ==
    



JohnFlux at 20:11, 23 October 2007
2007-10-23T20:11:16Z


				
				
				
				
			
			← Older revision
			Revision as of 20:11, 23 October 2007
			
Line 1:
Line 1:
  + == Adding option to change the language ==
  + 
  It can be extremely useful for a user to be able to change the language of a specific application.  It is fortunately extremely easy to add such functionality to your program.   It can be extremely useful for a user to be able to change the language of a specific application.  It is fortunately extremely easy to add such functionality to your program.
    
Line 12:
Line 14:
    
  And that is it!  You will now have a Switch Application Language option in the Help menu.   And that is it!  You will now have a Switch Application Language option in the Help menu.
  + 
  + However the user will need to restart the application for the changes to take effect.
  + 
  + == Dynamically changing the GUI ==
  + 
  + One step better is to change the language on the fly, as soon as the user has selected a new language.
  + 
  + This can seem a fairly daunting task, as a typical program can contain many hundreds of translatable strings that will need to be retranslated, but fortunately a lot of the work is already done for, and just needs to be connected together.
  + 
  + When the language of an application is changed, a LanguageChanged QEvent is sent to every single widget.  The idea is that in the top level window you will listen for this event, tell the GUI to retranslate, tell the toolbars to retranslate, and then let any custom widgets clean up themselves.
  + 
  + So in your class that inherits from KXmlGuiWindow, add to the header file:
  + 
  + <code>
  +   class MyWindow {
  +     ...
  +    protected:
  +     void changeEvent( QEvent * event );
  +     void retranslateUi();
  +     KAction *mSomeAction;
  +     KAction *mQuitAction;
  +   }
  + </code>
  + 
  + and to the source file:
  + <code>
  + MyWindow::MyWindow() : KXmlGuiWindow( 0 )
  + {
  +   //setup the GUI.  There should be no i18n calls here, but instead
  +   //these calls should be in the retranslateUi() function
  +   //Set up the actions in the GUI
  +   mSomeAction = actionCollection()->addAction("something");
  +   mSomeAction->setIcon(KIcon("some-action"));
  +   connect(mSomeAction, SIGNAL(triggered(bool)), mWorkSpace, SLOT(newWorkSheet() ));
  + 
  +   //KStandardActions need to be handled careful.
  +   mQuitAction = NULL
  +   
  +   retranslateUi();
  +   // Use the KXmlGuiWindow class to setup the GUI
  +   setupGUI(ToolBar | Keys | StatusBar | Create);
  + }
  + 
  + void MyWindow::changeEvent( QEvent * event )
  + {
  +   if (event->type() == QEvent::LanguageChange) {
  +     // This will setup the menu, toolbars etc again, using the new language
  +     setupGUI(ToolBar | Keys | StatusBar | Create);
  +     retranslateUi();
  +   }
  +   KXmlGuiWindow::changeEvent(event);
  + }
  + 
  + void MyWindow::retranslateUi()
  + {
  +   // Set the window title
  +   setPlainCaption( i18n( "My Window" ) );
  +   // For custom actions, just set the text again
  +   mMyAction->setText(i18n( "&Do Something..." ));
  +   if(mQuitAction) {
  +     //If we have already set this up before, create a new dummy action
  +     // and grab what info we need from it
  +     KAction *tmpQuitAction = KStandardAction::quit( NULL, NULL, NULL );
  +     mQuitAction->setText(tmpQuitAction->text());
  +     mQuitAction->setWhatsThis(tmpQuitAction->whatsThis());
  +     mQuitAction->setToolTip(tmpQuitAction->toolTip());
  +     delete tmpQuitAction;
  +   } else
  +     mQuitAction = KStandardAction::quit( this, SLOT( close() ), actionCollection() );
  + }
  + 
  + </code>
  + 
  + Although these is fairly complicated, that's about all that's needed.  Just be careful whenever you add a new string somewhere that it can be translated.
  + 
  + The way it is done in Qt is to follow this pattern of having a retranslateUi() function that is called from both the constructor and from a LanguageChange event.



JohnFlux at 19:49, 23 October 2007
2007-10-23T19:49:19Z


				
				
				
				
			
			← Older revision
			Revision as of 19:49, 23 October 2007
			
Line 6:
Line 6:
    
  <code>   <code>
−   <Menu name="help"> + <Menu name="help">
       <Action name="switch_application_language"/>        <Action name="switch_application_language"/>
−   </Menu> + </Menu>
  </code>   </code>
    
  And that is it!  You will now have a Switch Application Language option in the Help menu.   And that is it!  You will now have a Switch Application Language option in the Help menu.





JohnFlux at 19:48, 23 October 2007
2007-10-23T19:48:33Z


				
				
				
				
			
			← Older revision
			Revision as of 19:48, 23 October 2007
			
Line 6:
Line 6:
    
  <code>   <code>
−    <Menu name="help"><Action name="switch_application_language"></Menu> +    <Menu name="help">
  +     <Action name="switch_application_language"/>
  +   </Menu>
  </code>   </code>
    
  And that is it!  You will now have a Switch Application Language option in the Help menu.   And that is it!  You will now have a Switch Application Language option in the Help menu.

← Older revision		Revision as of 14:19, 14 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Localization/Language Change}}~~	+

	{{TutorialBrowser\|		{{TutorialBrowser\|

← Older revision		Revision as of 14:47, 21 December 2007
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Localization/Language Change}}
		+
	{{TutorialBrowser\|		{{TutorialBrowser\|
	series=Localization\|		series=Localization\|

← Older revision		Revision as of 20:22, 23 October 2007
Line 1:		Line 1:
		+	{{TutorialBrowser\|
		+	series=Localization\|
		+	name=Dealing with Language Changes\|
		+	pre=[[../i18n\|Writing Applications With Localization in Mind]]\|
		+	}}
		+
	== Adding option to change the language ==		== Adding option to change the language ==

← Older revision		Revision as of 20:11, 23 October 2007
Line 1:		Line 1:
		+	== Adding option to change the language ==
		+
	It can be extremely useful for a user to be able to change the language of a specific application. It is fortunately extremely easy to add such functionality to your program.		It can be extremely useful for a user to be able to change the language of a specific application. It is fortunately extremely easy to add such functionality to your program.

Line 12:		Line 14:

	And that is it! You will now have a Switch Application Language option in the Help menu.		And that is it! You will now have a Switch Application Language option in the Help menu.
		+
		+	However the user will need to restart the application for the changes to take effect.
		+
		+	== Dynamically changing the GUI ==
		+
		+	One step better is to change the language on the fly, as soon as the user has selected a new language.
		+
		+	This can seem a fairly daunting task, as a typical program can contain many hundreds of translatable strings that will need to be retranslated, but fortunately a lot of the work is already done for, and just needs to be connected together.
		+
		+	When the language of an application is changed, a LanguageChanged QEvent is sent to every single widget. The idea is that in the top level window you will listen for this event, tell the GUI to retranslate, tell the toolbars to retranslate, and then let any custom widgets clean up themselves.
		+
		+	So in your class that inherits from KXmlGuiWindow, add to the header file:
		+
		+	<code>
		+	class MyWindow {
		+	...
		+	protected:
		+	void changeEvent( QEvent * event );
		+	void retranslateUi();
		+	KAction *mSomeAction;
		+	KAction *mQuitAction;
		+	}
		+	</code>
		+
		+	and to the source file:
		+	<code>
		+	MyWindow::MyWindow() : KXmlGuiWindow( 0 )
		+	{
		+	//setup the GUI. There should be no i18n calls here, but instead
		+	//these calls should be in the retranslateUi() function
		+	//Set up the actions in the GUI
		+	mSomeAction = actionCollection()->addAction("something");
		+	mSomeAction->setIcon(KIcon("some-action"));
		+	connect(mSomeAction, SIGNAL(triggered(bool)), mWorkSpace, SLOT(newWorkSheet() ));
		+
		+	//KStandardActions need to be handled careful.
		+	mQuitAction = NULL
		+
		+	retranslateUi();
		+	// Use the KXmlGuiWindow class to setup the GUI
		+	setupGUI(ToolBar \| Keys \| StatusBar \| Create);
		+	}
		+
		+	void MyWindow::changeEvent( QEvent * event )
		+	{
		+	if (event->type() == QEvent::LanguageChange) {
		+	// This will setup the menu, toolbars etc again, using the new language
		+	setupGUI(ToolBar \| Keys \| StatusBar \| Create);
		+	retranslateUi();
		+	}
		+	KXmlGuiWindow::changeEvent(event);
		+	}
		+
		+	void MyWindow::retranslateUi()
		+	{
		+	// Set the window title
		+	setPlainCaption( i18n( "My Window" ) );
		+	// For custom actions, just set the text again
		+	mMyAction->setText(i18n( "&Do Something..." ));
		+	if(mQuitAction) {
		+	//If we have already set this up before, create a new dummy action
		+	// and grab what info we need from it
		+	KAction *tmpQuitAction = KStandardAction::quit( NULL, NULL, NULL );
		+	mQuitAction->setText(tmpQuitAction->text());
		+	mQuitAction->setWhatsThis(tmpQuitAction->whatsThis());
		+	mQuitAction->setToolTip(tmpQuitAction->toolTip());
		+	delete tmpQuitAction;
		+	} else
		+	mQuitAction = KStandardAction::quit( this, SLOT( close() ), actionCollection() );
		+	}
		+
		+	</code>
		+
		+	Although these is fairly complicated, that's about all that's needed. Just be careful whenever you add a new string somewhere that it can be translated.
		+
		+	The way it is done in Qt is to follow this pattern of having a retranslateUi() function that is called from both the constructor and from a LanguageChange event.