Merge branch 'feature/update-external-obj' into develop

Author: delphidabbler

Src/CodeSnip.dpr

@@ -313,7 +313,6 @@ uses
   USelectionIOMgr in 'USelectionIOMgr.pas',
   USettings in 'USettings.pas',
   UShowCaseCtrl in 'UShowCaseCtrl.pas',
-  UShowPrefsPageAction in 'UShowPrefsPageAction.pas',
   USimpleDispatch in 'USimpleDispatch.pas',
   USingleton in 'USingleton.pas',
   USnipKindListAdapter in 'USnipKindListAdapter.pas',

Src/CodeSnip.dproj

@@ -510,7 +510,6 @@
 			<DCCReference Include="USelectionIOMgr.pas"/>
 			<DCCReference Include="USettings.pas"/>
 			<DCCReference Include="UShowCaseCtrl.pas"/>
-			<DCCReference Include="UShowPrefsPageAction.pas"/>
 			<DCCReference Include="USimpleDispatch.pas"/>
 			<DCCReference Include="USingleton.pas"/>
 			<DCCReference Include="USnipKindListAdapter.pas"/>

Src/ExternalObj.ridl

@@ -12,7 +12,7 @@
 
 [
   uuid(DA95AEFB-3FB5-4A9E-9F9D-A53DD05CA7D4),
-  version(13.0),
+  version(14.0),
   helpstring("CodeSnip DOM External Object Extender Type Library"),
   custom(DE77BA64-517C-11D1-A2DA-0000F8773CE9, 117441012),
   custom(DE77BA63-517C-11D1-A2DA-0000F8773CE9, 1219706147)
@@ -24,19 +24,19 @@ library ExternalObj
   importlib("stdole2.tlb");
 
   /*
-   * V13 interface of extension to browser DOM's "external" object.
+   * V14 interface of extension to browser DOM's "external" object.
    */
-  interface IWBExternal13;
+  interface IWBExternal14;
 
 
   [
     uuid(BA971829-ED4D-4092-BCAE-4B5DB1A2D74A),
-    version(13.0),
+    version(14.0),
     helpstring("DOM external object extender"),
     dual,
     oleautomation
   ]
-  interface IWBExternal13: IDispatch
+  interface IWBExternal14: IDispatch
   {
     /*
      * Update database from internet.
@@ -72,38 +72,25 @@ library ExternalObj
      */
     [id(0x0000006E)]
     HRESULT _stdcall DisplayCategory([in] BSTR CatID, [in] VARIANT_BOOL NewTab);
-    [id(0x0000006F)]
 
     /*
      * Open Snippets Editor ready to create a new snippet.
      */
+    [id(0x0000006F)]
     HRESULT _stdcall NewSnippet(void);
-    [id(0x00000070)]
 
     /*
      * Show news items from CodeSnip news feed.
      */
+    [id(0x00000070)]
     HRESULT _stdcall ShowNews(void);
-    [id(0x00000071)]
-
-    /*
-     * Check for program updates.
-     */
-    HRESULT _stdcall CheckForUpdates(void);
-    [id(0x00000072)]
 
     /*
      * Display the program's About box.
      */
+    [id(0x00000071)]
     HRESULT _stdcall ShowAboutBox(void);
-    [id(0x00000073)]
 
-    /*
-     * Displays a tab in the Preferences dialogue box.
-     *    @param TagCls [in] Class name of frame hosting required dialogue box
-     *      page.
-     */
-    HRESULT _stdcall ShowPrefsPage([in] BSTR ClsName);
   };
 
 };

Src/FmMain.pas

@@ -529,10 +529,6 @@   TMainForm = class(THelpAwareForm)
     ///  <summary>Selects a tab in the details pane where the tab is provided by
     ///  the TDetailTabAction instance referenced by Sender.</summary>
     procedure ActSelectDetailTabExecute(Sender: TObject);
-    ///  <summary>Displays Preferences dialogue box containing the single page
-    ///  specified by the TShowPrefsPageAction instance referenced by Sender.
-    ///  </summary>
-    procedure ActShowPrefsPageExecute(Sender: TObject);
     ///  <summary>Handles events that inform of changes to the database. The
     ///  EvtInfo object provides information about the change.</summary>
     procedure DBChangeHandler(Sender: TObject; const EvtInfo: IInterface);
@@ -587,8 +583,8 @@ implementation
   UCopySourceMgr, UDatabaseLoader, UDatabaseLoaderUI, UDetailTabAction,
   UEditSnippetAction, UExceptions, UHelpMgr, UHistoryMenus, UKeysHelper,
   UMessageBox, UNotifier, UNulDropTarget, UPrintMgr, UQuery, USaveSnippetMgr,
-  USaveUnitMgr, USelectionIOMgr, UShowPrefsPageAction, UUrl, UUserDBMgr, UView,
-  UViewItemAction, UWBExternal;
+  USaveUnitMgr, USelectionIOMgr, UUrl, UUserDBMgr, UView, UViewItemAction,
+  UWBExternal;
 
 
 {$R *.dfm}
@@ -1048,17 +1044,6 @@ procedure TMainForm.actSelectSnippetsExecute(Sender: TObject);
     DoSearchFilter(Search);
 end;
 
-procedure TMainForm.ActShowPrefsPageExecute(Sender: TObject);
-var
-  UpdateUI: Boolean;  // flag true if preference changes affect main window UI
-begin
-  fDialogMgr.ExecPreferencesDlg(
-    (Sender as TShowPrefsPageAction).FrameClassName, UpdateUI
-  );
-  if UpdateUI then
-    fMainDisplayMgr.CompleteRefresh;
-end;
-
 procedure TMainForm.ActSubmitOrExportUpdate(Sender: TObject);
 begin
   // TODO -cRefactor: rename method - no longer shared
@@ -1387,11 +1372,7 @@ procedure TMainForm.InitForm;
       );
       SetNewSnippetAction(actAddSnippet);
       SetNewsAction(actBlog);
-      // SetCheckForUpdatesAction(actProgramUpdates);
       SetAboutBoxAction(actAbout);
-      SetShowPrefsPageAction(
-        TActionFactory.CreateShowPrefsPageAction(Self, ActShowPrefsPageExecute)
-      );
     end;
 
     // Customise web browser controls in Details pane

Src/IntfNotifier.pas

@@ -77,18 +77,9 @@ interface
     ///  <summary>Displays news items from the CodeSnip news feed.</summary>
     procedure ShowNews;
 
-    // TODO -cNotifier: remove this method and remove from external object
-    ///  <summary>Checks for program updates.</summary>
-    procedure CheckForUpdates;
-
     ///  <summary>Displays the program's About Box.</summary>
     procedure ShowAboutBox;
 
-    ///  <summary>Displays the Preferences dialogue box containing the specified
-    ///  page.</summary>
-    ///  <param name="ClsName">string [in] Class name of the frame that
-    ///  implements the required preferences page.</param>
-    procedure ShowPrefsPage(const ClsName: string);
   end;
 
 type
@@ -149,18 +140,10 @@ interface
     ///  <param name="Action">TBasicAction [in] Required action.</param>
     procedure SetNewsAction(const Action: TBasicAction);
 
-    ///  <summary>Sets action used to check for program updates.</summary>
-    ///  <param name="Action">TBasicAction [in] Required action.</param>
-    procedure SetCheckForUpdatesAction(const Action: TBasicAction);
-
     ///  <summary>Sets action used to display the program's About Box.</summary>
     ///  <param name="Action">TBasicAction [in] Required action.</param>
     procedure SetAboutBoxAction(const Action: TBasicAction);
 
-    ///  <summary>Sets action used to display a given page of the Preferences
-    ///  dialogue box.</summary>
-    ///  <param name="Action">TBasicAction [in] Required action.</param>
-    procedure SetShowPrefsPageAction(const Action: TBasicAction);
   end;
 
 type

Src/Res/Scripts/external.js

@@ -85,15 +85,6 @@ function showNews() {
   return false;
 }
 
-/*
- * Calls external object to get host application to check for program updates.
- *  @return False.
- */
-function checkForUpdates() {
-  external.CheckForUpdates();
-  return false;
-}
-
 /*
  * Calls external object to get host application to display About box.
  *  @return False,
@@ -102,15 +93,3 @@ function showAboutBox() {
   external.ShowAboutBox();
   return false;
 }
-
-/*
- * Calls external object to display the tab with the given frame class in the
- * Preferences dialogue box.
- *  @param string tabCls [in] Name of class of frame hosting required
- *    preferences page.
- *  @return False.
- */
-function showPrefsPage(tabCls) {
-  external.ShowPrefsPage(tabCls);
-  return false;
-}

Src/UActionFactory.pas

@@ -85,14 +85,6 @@   TActionFactory = class(TNoConstructObject)
         @param OnExecHandler [in] Handler for action's OnExecute event.
         @return Reference to newly created action.
       }
-    class function CreateShowPrefsPageAction(const AOwner: TComponent;
-      const OnExecHandler: TNotifyEvent = nil): TBasicAction;
-      {Creates a Show Preferences Page action and sets OnExecute handler id
-      provided.
-        @param AOwner [in] Owner of action.
-        @param OnExecHandler [in] Handler for action's OnExecute event.
-        @return Reference to newly created action.
-      }
   end;
 
 
@@ -103,8 +95,12 @@ implementation
   // Delphi
   StdActns,
   // Project
-  UCategoryAction, UDetailTabAction, UEditSnippetAction, ULinkAction,
-  UShowPrefsPageAction, USnippetAction, UViewItemAction;
+  UCategoryAction,
+  UDetailTabAction,
+  UEditSnippetAction,
+  ULinkAction,
+  USnippetAction,
+  UViewItemAction;
 
 
 { TActionFactory }
@@ -168,18 +164,6 @@ class function TActionFactory.CreateLinkAction(const AOwner: TComponent;
   Result := CreateAction(TLinkAction, AOwner, OnExecHandler) as TCustomAction;
 end;
 
-class function TActionFactory.CreateShowPrefsPageAction(
-  const AOwner: TComponent; const OnExecHandler: TNotifyEvent): TBasicAction;
-  {Creates a Show Preferences Page action and sets OnExecute handler id
-  provided.
-    @param AOwner [in] Owner of action.
-    @param OnExecHandler [in] Handler for action's OnExecute event.
-    @return Reference to newly created action.
-  }
-begin
-  Result := CreateAction(TShowPrefsPageAction, AOwner, OnExecHandler);
-end;
-
 class function TActionFactory.CreateSnippetAction(const AOwner: TComponent;
   const OnExecHandler: TNotifyEvent): TBasicAction;
   {Creates a Snippet action and sets OnExecute handler if provided.

Src/UNotifier.pas

@@ -62,14 +62,8 @@   TNotifier = class(TInterfacedObject, INotifier, ISetActions)
       ///  <summary>Action that causes news items from CodeSnip news feed to be
       ///  displayed.</summary>
       fNewsAction: TBasicAction;
-      ///  <summary>Action that causes a check for program updates to be
-      ///  performed.</summary>
-      fCheckForUpdatesAction: TBasicAction;
       ///  <summary>Action that causes About box to be displayed.</summary>
       fAboutBoxAction: TBasicAction;
-      ///  <summary>Action that displays a specified page in the preferences
-      ///  dialogue box.</summary>
-      fShowPrefsPageAction: TBasicAction;
 
   public
 
@@ -135,21 +129,10 @@   TNotifier = class(TInterfacedObject, INotifier, ISetActions)
     ///  <remarks>Methods of INotifier.</remarks>
     procedure ShowNews;
 
-    ///  <summary>Checks for program updates.</summary>
-    ///  <remarks>Methods of INotifier.</remarks>
-    procedure CheckForUpdates;
-
     ///  <summary>Displays the program's About Box.</summary>
     ///  <remarks>Methods of INotifier.</remarks>
     procedure ShowAboutBox;
 
-    ///  <summary>Displays the Preferences dialogue box containing the specified
-    ///  page.</summary>
-    ///  <param name="ClsName">string [in] Class name of the frame that
-    ///  implements the required preferences page.</param>
-    ///  <remarks>Method of INotifier.</remarks>
-    procedure ShowPrefsPage(const ClsName: string);
-
     ///  <summary>Sets action used to request a database update.</summary>
     ///  <param name="Action">TBasicAction [in] Required action.</param>
     ///  <remarks>Methods of ISetActions.</remarks>
@@ -212,21 +195,11 @@   TNotifier = class(TInterfacedObject, INotifier, ISetActions)
     ///  <remarks>Methods of ISetActions.</remarks>
     procedure SetNewsAction(const Action: TBasicAction);
 
-    ///  <summary>Sets action used to check for program updates.</summary>
-    ///  <param name="Action">TBasicAction [in] Required action.</param>
-    ///  <remarks>Methods of ISetActions.</remarks>
-    procedure SetCheckForUpdatesAction(const Action: TBasicAction);
-
     ///  <summary>Sets action used to display the program's About Box.</summary>
     ///  <param name="Action">TBasicAction [in] Required action.</param>
     ///  <remarks>Methods of ISetActions.</remarks>
     procedure SetAboutBoxAction(const Action: TBasicAction);
 
-    ///  <summary>Sets action used to display a given page of the Preferences
-    ///  dialogue box.</summary>
-    ///  <param name="Action">TBasicAction [in] Required action.</param>
-    ///  <remarks>Method of ISetActions.</remarks>
-    procedure SetShowPrefsPageAction(const Action: TBasicAction);
   end;
 
 
@@ -237,8 +210,12 @@ implementation
   // Delphi
   SysUtils, StdActns,
   // Project
-  Compilers.UGlobals, UCategoryAction, UDetailTabAction, UEditSnippetAction,
-  UShowPrefsPageAction, USnippetAction, UViewItemAction;
+  Compilers.UGlobals,
+  UCategoryAction,
+  UDetailTabAction,
+  UEditSnippetAction,
+  USnippetAction,
+  UViewItemAction;
 
 
 { TNotifier }
@@ -260,12 +237,6 @@ procedure TNotifier.ChangeOverviewStyle(const Style: Integer);
     fOverviewStyleChangeActions[Style].Execute;
 end;
 
-procedure TNotifier.CheckForUpdates;
-begin
-  if Assigned(fCheckForUpdatesAction) then
-    fCheckForUpdatesAction.Execute;
-end;
-
 procedure TNotifier.ConfigCompilers;
 begin
   if Assigned(fConfigCompilersAction) then
@@ -314,11 +285,6 @@ procedure TNotifier.SetAboutBoxAction(const Action: TBasicAction);
   fAboutBoxAction := Action;
 end;
 
-procedure TNotifier.SetCheckForUpdatesAction(const Action: TBasicAction);
-begin
-  fCheckForUpdatesAction := Action;
-end;
-
 procedure TNotifier.SetConfigCompilersAction(const Action: TBasicAction);
 begin
   fConfigCompilersAction := Action;
@@ -379,13 +345,6 @@ procedure TNotifier.SetOverviewStyleChangeActions(
     fOverviewStyleChangeActions[Idx] := Actions[Idx];
 end;
 
-procedure TNotifier.SetShowPrefsPageAction(const Action: TBasicAction);
-begin
-  Assert(Action is TShowPrefsPageAction, ClassName
-    + '.SetShowPreferencesAction: Action is not TShowPrefsPageAction');
-  fShowPrefsPageAction := Action;
-end;
-
 procedure TNotifier.SetShowViewItemAction(const Action: TBasicAction);
 begin
   fShowViewItemAction := Action;
@@ -409,15 +368,6 @@ procedure TNotifier.ShowNews;
     fNewsAction.Execute;
 end;
 
-procedure TNotifier.ShowPrefsPage(const ClsName: string);
-begin
-  if Assigned(fShowPrefsPageAction) then
-  begin
-    (fShowPrefsPageAction as TShowPrefsPageAction).FrameClassName := ClsName;
-    fShowPrefsPageAction.Execute;
-  end;
-end;
-
 procedure TNotifier.ShowViewItem(ViewItem: IView; const NewTab: Boolean);
 begin
   if Assigned(fShowViewItemAction) then