How to use smart docking - Revision history

Manus: Replaced origo.ethz.ch by eiffel.com in SVN URL

2012-06-04T21:19:52Z

Replaced origo.ethz.ch by eiffel.com in SVN URL

← Older revision		Revision as of 21:19, 4 June 2012
Line 2:		Line 2:
	* There is a simple docking project example, is in the SVN:		* There is a simple docking project example, is in the SVN:

	https://svn.~~origo~~.~~ethz.ch~~/eiffelstudio/trunk/Src/examples/docking		https://svn.eiffel.com/eiffelstudio/trunk/Src/examples/docking

	If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. It should looks like figure 1.		If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. It should looks like figure 1.

Larryl: /* SD_DOCKING_MANAGER */

2010-11-04T04:00:32Z

SD_DOCKING_MANAGER

← Older revision		Revision as of 04:00, 4 November 2010
Line 20:		Line 20:
	</Eiffel>		</Eiffel>

	~~<div style="background-color: brown; color: white; padding: 2px;">~~What is the meaning of those two arguments? Why are they necessary?		*What is the meaning of those two arguments?
	Is a_window always the parent window of a_container?~~</div>~~
			`a_container' is the top level container which hold all docking widgets

			`a_window' is the main window which hold `a_container'

			*Why are they necessary?

			`a_window' is used for register global shortcuts (such as `esc' key used for cancel a dragging), it also used for showing a parented floating docking panel, and used for set global cursor icon when dragging, etc...

			Between `a_container' and `a_window', maybe there are other non-dockable widgets exist if client programmer wish. So client programmers need to give the two arguments to docking manager.

			*Is `a_window' always the parent window of `a_container'?

			`a_container' and `a_window' can be the same object simply, otherwise `a_window' must be the parent window of `a_container'?

	== SD_CONTENT ==		== SD_CONTENT ==

Dfurrer at 12:17, 6 May 2009

2009-05-06T12:17:06Z

← Older revision		Revision as of 12:17, 6 May 2009
Line 11:		Line 11:

	As a client programmer you only need to care about four classes in the DOCKING LIBRARY cluster.		As a client programmer you only need to care about four classes in the DOCKING LIBRARY cluster.
	*SD_DOCKING_MANAGER
			== SD_DOCKING_MANAGER ==
	This is the class which controls the whole SMART DOCKING library.		This is the class which controls the whole SMART DOCKING library.
	Use it like this:		Use it like this:
Line 37:		Line 38:
	For more information about SD_CONTENT, see [[How to use smart docking sd content]]		For more information about SD_CONTENT, see [[How to use smart docking sd content]]

	~~----~~		== SD_ICONS_SINGLETON (deferred)==

	*SD_ICONS_SINGLETON (deferred)
	This is the class which provide docking library pixmaps for icons or dragging feedback.		This is the class which provide docking library pixmaps for icons or dragging feedback.
	By default, Smart Docking library provide embedded icons which can be used directly without any changes. But if you want to customize your icons, you should inherit this class and implement several once features which provide EV_PIXMAPs		By default, Smart Docking library provide embedded icons which can be used directly without any changes. But if you want to customize your icons, you should inherit this class and implement several once features which provide EV_PIXMAPs
Line 62:		Line 61:
	</Eiffel>		</Eiffel>
	And you should call 'init' feature in SD_ICONS_SINGLETON, normally you can call it in the creation method of the SD_ICONS_SINGLETON implementation class.		And you should call 'init' feature in SD_ICONS_SINGLETON, normally you can call it in the creation method of the SD_ICONS_SINGLETON implementation class.
	~~----~~
	* SD_ENUMERATION		== SD_ENUMERATION ==
	This class only contain enumerations of Smart Docking library, such as direction enumeration, SD_CONTENT type enumeration.		This class only contain enumerations of Smart Docking library, such as direction enumeration, SD_CONTENT type enumeration.

	For more information about SD_ENUMERATION, see [[How to use smart docking sd enumeration]]		For more information about SD_ENUMERATION, see [[How to use smart docking sd enumeration]]

Dfurrer: /* SD_CONTENT */

2009-05-06T12:15:23Z

SD_CONTENT

← Older revision		Revision as of 12:15, 6 May 2009
Line 28:		Line 28:
	<Eiffel>		<Eiffel>
	content: SD_CONTENT		content: SD_CONTENT
	create content.make (create {~~USER_CONTENT~~}, "A_unique_title")		create content.make (create {EV_BUTTON}, "A_unique_title")
	content.set_short_title ("A short title")		content.set_short_title ("A short title")
	content.set_long_title ("A long title")		content.set_long_title ("A long title")

Dfurrer at 12:07, 6 May 2009

2009-05-06T12:07:06Z

← Older revision		Revision as of 12:07, 6 May 2009
Line 4:		Line 4:
	https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/examples/docking		https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/examples/docking

	If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. ~~After complied, it~~ should looks like figure 1.		If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. It should looks like figure 1.

	[[Image:How_to_use_smart_docking_figure_1.png]]		[[Image:How_to_use_smart_docking_figure_1.png]]
Line 32:		Line 32:
	content.set_long_title ("A long title")		content.set_long_title ("A long title")
	manager.contents.extend (content)		manager.contents.extend (content)
	-- You should call the following feature~~, otherwise~~ the content ~~will not~~ visible.		-- You should call the following feature to make the content visible.
	content.set_top ({SD_ENUMERATION}.top)		content.set_top ({SD_ENUMERATION}.top)
	</Eiffel>		</Eiffel>
Line 41:		Line 41:
	*SD_ICONS_SINGLETON (deferred)		*SD_ICONS_SINGLETON (deferred)
	This is the class which provide docking library pixmaps for icons or dragging feedback.		This is the class which provide docking library pixmaps for icons or dragging feedback.
	By default, Smart Docking library provide embedded icons which can be used directly without any changes. But if you want to customize your icons, you should inherit this class~~, to~~ implement several once ~~functions~~ which provide EV_PIXMAPs		By default, Smart Docking library provide embedded icons which can be used directly without any changes. But if you want to customize your icons, you should inherit this class and implement several once features which provide EV_PIXMAPs
	like this:		like this:
	<Eiffel>		<Eiffel>
Line 64:		Line 64:
	----		----
	* SD_ENUMERATION		* SD_ENUMERATION
	This class only contain enumerations of Smart Docking library, such as ~~direciton eumeration~~, SD_CONTENT type enumeration.		This class only contain enumerations of Smart Docking library, such as direction enumeration, SD_CONTENT type enumeration.

	For more ~~informations~~ about SD_ENUMERATION, see [[How to use smart docking sd enumeration]]		For more information about SD_ENUMERATION, see [[How to use smart docking sd enumeration]]

Dfurrer at 11:58, 6 May 2009

2009-05-06T11:58:33Z

← Older revision		Revision as of 11:58, 6 May 2009
Line 10:		Line 10:
	----		----

	~~The~~ client programmer only care about 4 classes in DOCKING LIBRARY.		As a client programmer you only need to care about four classes in the DOCKING LIBRARY cluster.
	*SD_DOCKING_MANAGER		*SD_DOCKING_MANAGER
	This is the class which ~~control~~ the whole SMART DOCKING library.		This is the class which controls the whole SMART DOCKING library.
	~~Client programmer should use~~ it like this:		Use it like this:
	<Eiffel>		<Eiffel>
	manager: SD_DOCKING_MANAGER		manager: SD_DOCKING_MANAGER
	create manager.make (~~a_container_for_docking_manager~~, ~~a_window_for_docking_manager~~)		create manager.make (a_container, a_window)
	</Eiffel>		</Eiffel>

			<div style="background-color: brown; color: white; padding: 2px;">What is the meaning of those two arguments? Why are they necessary?
			Is a_window always the parent window of a_container?</div>

	== SD_CONTENT ==		== SD_CONTENT ==

	This is the class which ~~have~~ the ~~informations of client programmer want~~ to put in ~~the~~ docking ~~library~~.		This is the class which has the information to be put in a docking component.
	Client programmer should use it like this:		Client programmer should use it like this:
	<Eiffel>		<Eiffel>

Jfiat at 15:48, 11 October 2007

2007-10-11T15:48:27Z

← Older revision		Revision as of 15:48, 11 October 2007
Line 2:		Line 2:
	* There is a simple docking project example, is in the SVN:		* There is a simple docking project example, is in the SVN:

	https://~~eiffelsoftware~~.origo.ethz.ch/~~svn/es~~/trunk/Src/examples/docking		https://svn.origo.ethz.ch/eiffelstudio/trunk/Src/examples/docking

	If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. After complied, it should looks like figure 1.		If you have checked out SVN codes, it's in your SVN_ROOT/examples/docking folder. After complied, it should looks like figure 1.

Larryl at 03:44, 28 August 2007

2007-08-28T03:44:05Z

← Older revision		Revision as of 03:44, 28 August 2007
Line 14:		Line 14:
	This is the class which control the whole SMART DOCKING library.		This is the class which control the whole SMART DOCKING library.
	Client programmer should use it like this:		Client programmer should use it like this:
			<Eiffel>
	manager: SD_DOCKING_MANAGER		manager: SD_DOCKING_MANAGER
	create manager.make (a_container_for_docking_manager, a_window_for_docking_manager)		create manager.make (a_container_for_docking_manager, a_window_for_docking_manager)
			</Eiffel>

	== SD_CONTENT ==		== SD_CONTENT ==
Line 24:		Line 24:
	Client programmer should use it like this:		Client programmer should use it like this:
	<Eiffel>		<Eiffel>
	content: SD_CONTENT		content: SD_CONTENT
	create content.make (create {USER_CONTENT}, "A_unique_title")		create content.make (create {USER_CONTENT}, "A_unique_title")
	content.set_short_title ("A short title")		content.set_short_title ("A short title")
	content.set_long_title ("A long title")		content.set_long_title ("A long title")
	manager.contents.extend (content)		manager.contents.extend (content)
	-- You should call the following feature, otherwise the content will not visible.		-- You should call the following feature, otherwise the content will not visible.
	content.set_top ({SD_ENUMERATION}.top)		content.set_top ({SD_ENUMERATION}.top)
	</Eiffel>		</Eiffel>
	For more information about SD_CONTENT, see [[How to use smart docking sd content]]		For more information about SD_CONTENT, see [[How to use smart docking sd content]]
Line 41:		Line 41:
	like this:		like this:
	<Eiffel>		<Eiffel>
	arrow_indicator_up: EV_PIXMAP is		arrow_indicator_up: EV_PIXMAP is
	once		once
	create Result.default_create		create Result.default_create
	Result.set_with_named_file (".\arrow.png")		Result.set_with_named_file (".\arrow.png")
	end		end
	arrow_indicator_left: EV_PIXMAP is		arrow_indicator_left: EV_PIXMAP is
	once		once
	create Result.default_create		create Result.default_create
	Result.set_with_named_file (".\arrow_left.png")		Result.set_with_named_file (".\arrow_left.png")
	end		end
	arrow_indicator_center: EV_PIXMAP is		arrow_indicator_center: EV_PIXMAP is
	once		once
	create Result.default_create		create Result.default_create
	Result.set_with_named_file (".\arrow_center.png")		Result.set_with_named_file (".\arrow_center.png")
	end		end
	....		....
	</Eiffel>		</Eiffel>

Larryl: /* SD_CONTENT */

2007-08-28T03:40:45Z

SD_CONTENT

← Older revision		Revision as of 03:40, 28 August 2007
Line 23:		Line 23:
	This is the class which have the informations of client programmer want to put in the docking library.		This is the class which have the informations of client programmer want to put in the docking library.
	Client programmer should use it like this:		Client programmer should use it like this:
			<Eiffel>
	content: SD_CONTENT		content: SD_CONTENT
	create content.make (create {USER_CONTENT}, "A_unique_title")		create content.make (create {USER_CONTENT}, "A_unique_title")
Line 31:		Line 31:
	-- You should call the following feature, otherwise the content will not visible.		-- You should call the following feature, otherwise the content will not visible.
	content.set_top ({SD_ENUMERATION}.top)		content.set_top ({SD_ENUMERATION}.top)
			</Eiffel>
	For more information about SD_CONTENT, see [[How to use smart docking sd content]]		For more information about SD_CONTENT, see [[How to use smart docking sd content]]

Larryl: /* SD_CONTENT */

2007-08-28T03:40:27Z

SD_CONTENT

← Older revision		Revision as of 03:40, 28 August 2007
Line 38:		Line 38:
	*SD_ICONS_SINGLETON (deferred)		*SD_ICONS_SINGLETON (deferred)
	This is the class which provide docking library pixmaps for icons or dragging feedback.		This is the class which provide docking library pixmaps for icons or dragging feedback.
	~~Client programmer~~ should inherit this class, to implement several once functions which provide EV_PIXMAPs		By default, Smart Docking library provide embedded icons which can be used directly without any changes. But if you want to customize your icons, you should inherit this class, to implement several once functions which provide EV_PIXMAPs
	like this:		like this:
			<Eiffel>
	arrow_indicator_up: EV_PIXMAP is		arrow_indicator_up: EV_PIXMAP is
	once		once
Line 57:		Line 57:
	end		end
	....		....
			</Eiffel>
	And you should call 'init' feature in SD_ICONS_SINGLETON, normally you can call it in the creation method of the SD_ICONS_SINGLETON implementation class.		And you should call 'init' feature in SD_ICONS_SINGLETON, normally you can call it in the creation method of the SD_ICONS_SINGLETON implementation class.
	----		----