Startup script - Revision history

Mandrav: Updated info for latest changes

2006-12-15T12:29:54Z

Updated info for latest changes

← Older revision		Revision as of 12:29, 15 December 2006
Line 1:		Line 1:
	[[Category:Scripting Code::Blocks]]		[[Category:Scripting Code::Blocks]]

	When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then ~~tries to execute the~~ ''"function main()"'' inside it ~~(if there~~). The user can edit this script to run arbitrary customization commands on application startup.		When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then executes it (no need for ''"function main()"'' inside it anymore). The user can edit this script to run arbitrary customization commands on application startup.
	The shipped ''startup.script'' ~~just logs its presence in~~ the ~~application's debug log~~.		The shipped ''startup.script'' demonstrates a couple of the newest scripting features.

	~~function main~~()		Log(_T("Running startup script"));
	{
	~~Log~~(_T("~~Running startup~~ script"));		// #include any script plugins; this will register them too
	}		// un-comment the line below to register a pointless sample plugin
			// Include(_T("sample_plugin.script"));

			// add a menu entry to edit this script
			GetScriptingManager().RegisterScriptMenu(_T("edit_startup_script.script"), _T("Settings/-Edit startup script"));


	== Example ==		== Example ==
	~~As an~~ example~~, you could register some scripts you have written and bind them to~~ Code::Blocks~~' menus~~.		An example script is now shipping with Code::Blocks. Please read the last line of the startup.script above:

	~~To do this, you will need to access~~ the ~~''[[Scripting commands#Application object\|application object]]''. It provides the '''<tt>RegisterScript</tt>''' function which comes handy for our little example :).~~

	~~First thing you need to do is either:~~
	* edit the global startup script (which can be found in the <tt>share/codeblocks/scripts</tt> subfolder of the ~~folder you installed Code::Blocks, or~~
	* create you own startup.script in your home folder (if Code::Blocks "sees" the script in your home folder, it will always favor it over the globally installed one). For unix systems this folder would be "<tt>~/.codeblocks/share/codeblocks/scripts</tt>" while for windows XP "<tt>C:\Documents and Settings\''username''\Application Data\codeblocks\Share\codeblocks\scripts</tt>".

	~~Now, let's edit our startup script:~~

	~~function main()~~
	{
	~~Log(_T("Running~~ startup ~~script"));~~

	~~// register a script with Code::Blocks' menus~~
	~~App.RegisterScript("sample.script", "Scripts/Sample script");~~
	}

	~~That wasn't hard, was it? We added a single line which will add a menu "Scripts" in the menu bar. Inside this "Scripts" menu it will add a "Sample script" item~~. ~~When you click on this item, the~~ script ~~"sample.script" will be executed. Simple~~ :).

	~~All you have~~ to ~~do now~~, ~~is create the~~ "~~sample.~~script" ~~file in the same folder. Here's an example:~~		// add a menu entry to edit this script
			GetScriptingManager().RegisterScriptMenu(_T("edit_startup_script.script"), _T("Settings/-Edit startup script"));

	// ~~A sample~~ script		This actually binds the script named <tt>edit_startup_script.script</tt> to the menu entry <tt>"Settings/-Edit startup script"</tt>.
	~~ShowMessage(_T(~~"~~Hello from inside the sample script!"));~~

	And don't forget that Code::Blocks conveniently allows you to edit the ~~"sample~~.script" at any time. All you have to do is keep SHIFT pressed while clicking on the "~~Sample~~ script" menu item ;).		And don't forget that Code::Blocks conveniently allows you to edit the <tt>edit_startup_script.script</tt> at any time. All you have to do is keep SHIFT pressed while clicking on the <tt>"Edit startup script"</tt> menu item ;).

Mandrav: Added example

2006-12-10T20:17:55Z

Added example

@@ Line 8: / Line 8: @@
       Log(_T("Running startup script"));
+  }
 == See also ==
 * [[Scripting commands]]

Artojon: removed extra category

2006-11-11T17:40:57Z

removed extra category

← Older revision		Revision as of 17:40, 11 November 2006
Line 1:		Line 1:
	~~[[Category:Code::Blocks_Documentation]]~~
	[[Category:Scripting Code::Blocks]]		[[Category:Scripting Code::Blocks]]

Artojon: wikify

2006-07-07T19:02:02Z

wikify

← Older revision		Revision as of 19:02, 7 July 2006
Line 1:		Line 1:
			[[Category:Code::Blocks_Documentation]]
			[[Category:Scripting Code::Blocks]]

	When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.		When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.
	The shipped ''startup.script'' just logs its presence in the application's debug log.		The shipped ''startup.script'' just logs its presence in the application's debug log.
Line 7:		Line 10:
	}		}

	See also~~: [[scripting commands]].~~		== See also ==

	~~Back to [[Scripting_Code::Blocks\|scripting index]].~~

	[[~~Category:Code::Blocks_Documentation~~]]		* [[Scripting commands]]

Mandrav: /* Startup */

2006-07-03T09:44:47Z

Startup

← Older revision		Revision as of 09:44, 3 July 2006
Line 1:		Line 1:
	~~== Startup ==~~

	When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.		When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.
	The shipped ''startup.script'' just logs its presence in the application's debug log.		The shipped ''startup.script'' just logs its presence in the application's debug log.
Line 10:		Line 8:

	See also: [[scripting commands]].		See also: [[scripting commands]].

			Back to [[Scripting_Code::Blocks\|scripting index]].

	[[Category:Code::Blocks_Documentation]]		[[Category:Code::Blocks_Documentation]]

Mandrav: /* Startup */

2006-07-03T09:43:32Z

Startup

← Older revision		Revision as of 09:43, 3 July 2006
Line 10:		Line 10:

	See also: [[scripting commands]].		See also: [[scripting commands]].
	[[Category:~~Documentation~~]]		[[Category:Code::Blocks_Documentation]]

Mandrav: Initial

2006-07-03T09:42:28Z

Initial

New page

== Startup ==

When Code::Blocks finishes loading, it tries to load a script named ''startup.script''. If it is found it then tries to execute the ''"function main()"'' inside it (if there). The user can edit this script to run arbitrary customization commands on application startup.
The shipped ''startup.script'' just logs its presence in the application's debug log.

function main()
{
Log(_T("Running startup script"));
}

See also: [[scripting commands]].
[[Category:Documentation]]