From c2c16f0c8ecff2f1da3f0f965238e6f2f8d310d6 Mon Sep 17 00:00:00 2001 From: halw Date: Fri, 28 Oct 2011 16:02:58 +0000 Subject: [PATCH] Author:halw Date:2011-10-26T20:34:24.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1000 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- .../eiffelribbon-design-tool.wiki | 4 ++ .../microsoft-windows/eiffelribbon/index.wiki | 46 +++++++++---------- 2 files changed, 27 insertions(+), 23 deletions(-) diff --git a/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/eiffelribbon-design-tool.wiki b/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/eiffelribbon-design-tool.wiki index e393024c..33b230fc 100644 --- a/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/eiffelribbon-design-tool.wiki +++ b/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/eiffelribbon-design-tool.wiki @@ -19,6 +19,8 @@ The interface of the design tool mimics that of [[EiffelBuild|EiffelBuild]]. Tha So, if you've used EiffelBuild, the the EiffelRibbon design tool should seem quite familiar to you. +=Usage= + The typical usage of the design tool is much like the typical usage of EiffelBuild. * Create a new project ( File -> New Project... ) and choose a location for your EiffelRibbon project. @@ -29,3 +31,5 @@ The typical usage of the design tool is much like the typical usage of EiffelBui + + diff --git a/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/index.wiki b/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/index.wiki index 18302115..8e234a1a 100644 --- a/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/index.wiki +++ b/documentation/current/platform-specifics/microsoft-windows/eiffelribbon/index.wiki @@ -24,6 +24,29 @@ To gain a detailed understanding of the goals of Microsoft's Ribbon technology i The [[EiffelRibbon Design Tool|EiffelRibbon design tool]] helps you configure a ribbon in much the same way that [[EiffelBuild|EiffelBuild]] (ES Builder) helps you layout a GUI application. +=The EiffelRibbon Library= + +The EiffelRibbon library contains the classes necessary to add ribbons to EiffelVision 2 applications. As stated above, you won't really need to use the library directly. Rather, you use the EiffelRibbon tool to build an application that uses the library classes. + +Still you may find it interesting to browse the classes in the library. You'll see that as in the EiffelVision 2 library, many of the classes are there to provide support for the various elements that can be used in an application. Most of the class names for EiffelRibbon-specific elements begin with the prefix "EV_RIBBON". Some examples are: EV_RIBBON_BUTTON, EV_RIBBON_DROP_DOWN_GALLERY, and EV_RIBBON_COMBO_BOX_ITEM. Again, similar to EiffelVision 2, the class EV_RIBBON_COMBO_BOX_ITEM models an item for a EV_RIBBON_COMBO_BOX. + +So, here again, if you are familiar with EiffelVision 2, then EiffelRibbon should not seem very foreign to you. + + +=EiffelRibbon Applications= + +When you build an application with the [[EiffelRibbon Design Tool|EiffelRibbon tool]], it generates classes for you. These classes are often clients or heirs to classes in the EiffelRibbon library. The classes generated for the objects on your ribbon should look familiar to you as well. For example, as with EiffelBuild, for each ribbon object, say a button, there will be a class ending with the suffix "_IMP" which will get regenerated each time you request the EiffelRibbon tool to generate classes. Also generated is an heir to that class with a name that does not include the suffix. This class you are free to edit, as it will not be regenerated. It is in these editable classes that you provide the action sequences for your ribbon objects' behaviors. + +The class shown in the Edit pane of EiffelStudio in Figure 2 is a portion of a generated class BUTTON_CHANGE_SMALL_IMAGE, representing a ribbon button, from one of the EiffelRibbon examples. BUTTON_CHANGE_SMALL_IMAGE is a heir to BUTTON_CHANGE_SMALL_IMAGE_IMP. You can see that in the redefined version of create_interface_objects code has been added to add an agent to the select_actions for the ribbon button. In this case, it's an inline agent that will toggle the associated image back and forth between two different images. + + +[[Image:EiffelRibbon application 01|An EiffelRibbon application in EiffelStudio.]] + +Figure 2. + + +=Usage notes= + ==System requirements== To use the EiffelRibbon library and tools you must have: @@ -46,27 +69,4 @@ Initial distribution: * Resizing policy is not yet supported. * When working in Application Mode, it is necessary to freeze the target system each time the EiffelRibbon code is regenerated. This is not necessary in DLL Mode. -=The EiffelRibbon Library= - -The EiffelRibbon library contains the classes necessary to add ribbons to EiffelVision 2 applications. As stated above, you won't really need to use the library directly. Rather, you use the EiffelRibbon tool to build an application that uses the library classes. - -Still you may find it interesting to browse the classes in the library. You'll see that as in the EiffelVision 2 library, many of the classes are there to provide support for the various elements that can be used in an application. Most of the class names for EiffelRibbon-specific elements begin with the prefix "EV_RIBBON". Some examples are: EV_RIBBON_BUTTON, EV_RIBBON_DROP_DOWN_GALLERY, and EV_RIBBON_COMBO_BOX_ITEM. Again, similar to EiffelVision 2, the class EV_RIBBON_COMBO_BOX_ITEM models an item for a EV_RIBBON_COMBO_BOX. - -So, here again, if you are familiar with EiffelVision 2, then EiffelRibbon should not seem very foreign to you. - - -=EiffelRibbon Applications= - -When you build an application with the EiffelRibbon tool, it generates classes for you. These classes are often clients or heirs to classes in the EiffelRibbon library. The classes generated for the objects on your ribbon should look familiar to you as well. For example, as with EiffelBuild, for each ribbon object, say a button, there will be a class ending with the suffix "_IMP" which will get regenerated each time you request the EiffelRibbon tool to generate classes. Also generated is an heir to that class with a name that does not include the suffix. This class you are free to edit, as it will not be regenerated. It is in these editable classes that you provide the action sequences for your ribbon objects' behaviors. - -The class shown in the Edit pane of EiffelStudio in Figure 2 is a portion of a generated class BUTTON_CHANGE_SMALL_IMAGE, representing a ribbon button, from one of the EiffelRibbon examples. BUTTON_CHANGE_SMALL_IMAGE is a heir to BUTTON_CHANGE_SMALL_IMAGE_IMP. You can see that in the redefined version of create_interface_objects code has been added to add an agent to the select_actions for the ribbon button. In this case, it's an inline agent that will toggle the associated image back and forth between two different images. - - -[[Image:EiffelRibbon application 01|An EiffelRibbon application in EiffelStudio.]] - -Figure 2. - - - -