home *** CD-ROM | disk | FTP | other *** search
/ Tools / WinSN5.0Ver.iso / NETSCAP.50 / WIN1998.ZIP / ns / include / bkmks.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-04-08  |  26.2 KB  |  701 lines
  1. /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * The contents of this file are subject to the Netscape Public License
  4.  * Version 1.0 (the "NPL"); you may not use this file except in
  5.  * compliance with the NPL.  You may obtain a copy of the NPL at
  6.  * http://www.mozilla.org/NPL/
  7.  *
  8.  * Software distributed under the NPL is distributed on an "AS IS" basis,
  9.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
  10.  * for the specific language governing rights and limitations under the
  11.  * NPL.
  12.  *
  13.  * The Initial Developer of this code under the NPL is Netscape
  14.  * Communications Corporation.  Portions created by Netscape are
  15.  * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
  16.  * Reserved.
  17.  */
  18. #ifndef BKMKS_H
  19. #define BKMKS_H
  20.  
  21. #include "xp_mcom.h"
  22. #include "ntypes.h"
  23.  
  24. XP_BEGIN_PROTOS
  25.  
  26. #define BM_LAST_CELL            0xFFFF /* See BMFE_RefreshCells */
  27.  
  28. typedef time_t BM_Date;
  29.  
  30. typedef enum {
  31.   BM_Cmd_Invalid,                /* XFE in particular likes to have an invalid
  32.                                    ID code as one of the entries here...*/
  33.  
  34.   BM_Cmd_Open,                    /* Open a new bookmark file. */
  35.  
  36.   BM_Cmd_ImportBookmarks,        /* Import entries from another bookmark
  37.                                    file. */
  38.  
  39.   BM_Cmd_SaveAs,                /* Save these bookmarks into another file. */
  40.  
  41.   BM_Cmd_Close,                    /* Close the bookmarks window.  (NYI ###) */
  42.  
  43.   BM_Cmd_Undo,                    /* Undo the last command. */
  44.   BM_Cmd_Redo,                    /* Redo the last undone command. */
  45.  
  46.   BM_Cmd_Cut,                    /* Cut the selected bookmarks. */
  47.   BM_Cmd_Copy,                    /* Copy the selected bookmarks. */
  48.   BM_Cmd_Paste,                    /* Paste in the most recent cut/copy. */
  49.   BM_Cmd_Delete,                /* Delete the selected bookmarks without
  50.                                    affecting the clipboard. */
  51.  
  52.   BM_Cmd_SelectAllBookmarks,    /* Select every bookmark in the window. */
  53.  
  54.   BM_Cmd_Find,                    /* Find a string. */
  55.  
  56.   BM_Cmd_FindAgain,                /* Find the same string again. */
  57.  
  58.   BM_Cmd_BookmarkProps,            /* Bring up the properties window.  */
  59.  
  60.   BM_Cmd_GotoBookmark,            /* Load the selected bookmark in a browser
  61.                                    window. */
  62.  
  63.                                 /* Sort the bookmarks.  NYI### */
  64.   BM_Cmd_Sort_Name,
  65.   BM_Cmd_Sort_Name_Asc,
  66.   
  67.   BM_Cmd_Sort_Address,
  68.   BM_Cmd_Sort_Address_Asc,
  69.   
  70.   BM_Cmd_Sort_AddDate,
  71.   BM_Cmd_Sort_AddDate_Asc,
  72.   
  73.   BM_Cmd_Sort_LastVisit,
  74.   BM_Cmd_Sort_LastVisit_Asc,      
  75.   
  76.   BM_Cmd_Sort_Natural,        
  77.   
  78.  
  79.   BM_Cmd_InsertBookmark,        /* Insert a new bookmark (or a new address if
  80.                                    in addressbook). */
  81.  
  82.   BM_Cmd_InsertHeader,            /* Insert a new header. */
  83.  
  84.   BM_Cmd_InsertSeparator,        /* Insert a separator. */
  85.  
  86.   BM_Cmd_MakeAlias,                /* Make an alias of this bookmark. */
  87.  
  88.   BM_Cmd_SetAddHeader,            /* Make the current header be the one where new
  89.                                    bookmarks are added. */
  90.  
  91.   BM_Cmd_SetMenuHeader            /* Make the current header be the one which the
  92.                                    pulldown menu is created from. */
  93.  
  94. } BM_CommandType;
  95. #define BM_Cmd_SortBookmarks  BM_Cmd_Sort_Name
  96.  
  97. typedef enum
  98. {
  99.    BM_Sort_NONE = -1,
  100.    
  101.    BM_Sort_Name,
  102.    BM_Sort_Name_Asc,
  103.    
  104.    BM_Sort_Address,
  105.    BM_Sort_Address_Asc,
  106.    
  107.    BM_Sort_AddDate,
  108.    BM_Sort_AddDate_Asc,
  109.    
  110.    BM_Sort_LastVisit,
  111.    BM_Sort_LastVisit_Asc,
  112.    
  113.    BM_Sort_Natural
  114.    
  115. } BM_SortType;
  116.  
  117. /* The various types of bookmark entries (as returned by BM_GetType). */
  118.  
  119. typedef uint16 BM_Type;
  120.  
  121. #define BM_TYPE_HEADER        0x0001
  122. #define BM_TYPE_URL            0x0002
  123. #define BM_TYPE_ADDRESS        0x0004
  124. #define BM_TYPE_SEPARATOR    0x0008
  125. #define BM_TYPE_ALIAS        0x0010 
  126.  
  127.  
  128. /* This represents one line in the bookmarks window -- a URL, a
  129.    separater, an addressbook entry, a header, etc.  It's also already
  130.    defined in ntypes.h, and some compilers bitch and moan about seeing it
  131.    twice, so I've commented it out here. */
  132. /* typedef struct BM_Entry_struct BM_Entry; */
  133.  
  134.  
  135.  
  136. /* information for the find dialog */
  137. typedef struct BM_FindInfo {
  138.   char* textToFind;
  139.   XP_Bool checkNickname;        /* Meaningful only in addressbook */
  140.   XP_Bool checkName;
  141.   XP_Bool checkLocation;
  142.   XP_Bool checkDescription;
  143.   XP_Bool matchCase;
  144.   XP_Bool matchWholeWord;
  145.     
  146.   BM_Entry*    lastEntry;
  147. } BM_FindInfo;
  148.  
  149. struct BM_Entry_Focus {
  150.   BM_Entry* saveFocus;
  151.   XP_Bool foundSelection;
  152. };
  153.  
  154. extern XP_Bool BM_IsHeader(BM_Entry* entry);
  155. extern XP_Bool BM_IsUrl(BM_Entry* entry);
  156. extern XP_Bool BM_IsAddress(BM_Entry* entry);
  157. extern XP_Bool BM_IsSeparator(BM_Entry* entry);
  158. extern XP_Bool BM_IsAlias(BM_Entry* entry);
  159. extern XP_Bool BM_IsFolded(BM_Entry* entry);
  160. extern XP_Bool BM_IsSelected(BM_Entry* entry);
  161.  
  162.  
  163. /* Returns the state of whether this is a "changed URL"; that is, a URL whose
  164.    contents have apparently changed since we last visited it. */
  165.  
  166. #define BM_CHANGED_YES            1
  167. #define BM_CHANGED_NO            0
  168. #define BM_CHANGED_UNKNOWN        -1
  169.  
  170. extern int32 BM_GetChangedState(BM_Entry* entry);
  171.  
  172.  
  173.  
  174. /* Get/Set the header that is to be the root of the pulldown menu. */
  175. extern BM_Entry* BM_GetMenuHeader(MWContext* context);
  176. extern void BM_SetMenuHeader(MWContext* context, BM_Entry* entry);
  177.  
  178. /* Get/Set the header that is to be the container of new items added from
  179.    browser windows. */
  180. extern BM_Entry* BM_GetAddHeader(MWContext* context);
  181. extern void BM_SetAddHeader(MWContext* context, BM_Entry* entry);
  182.  
  183.  
  184. typedef void (*EntryFunc)(MWContext* context, BM_Entry* entry, void* closure);
  185.  
  186.  
  187. /* Executes the given function on every single entry in the bookmark file. */
  188. extern void BM_EachEntryDo(MWContext* context, EntryFunc func, void* closure);
  189.  
  190. /* Executes the given function for every entry that is selected. */
  191. extern void BM_EachSelectedEntryDo(MWContext* context, EntryFunc func,
  192.                                    void* closure);
  193.  
  194. /* Executes the given function for every entry that is selected and is not a
  195.    descendent of a header that is not folded or selected. */
  196. extern void BM_EachProperSelectedEntryDo(MWContext* context, EntryFunc func,
  197.                             void* closure, struct BM_Entry_Focus* bmFocus);
  198.  
  199.  
  200. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  201.  
  202. /* Front end stubs -- each FE needs to implement these. */
  203.  
  204. /* Refresh each cell between and including first and last in the bookmarks
  205.    widget (if now is TRUE, the FE is expected to redraw them BEFORE returning,
  206.    otherwise the FE can simply invalidate them and wait for the redraw to
  207.    happen).  If BM_LAST_CELL is passed in as last, then it means paint from
  208.    the first to the end. */
  209. extern void BMFE_RefreshCells(MWContext* context, int32 first, int32 last,
  210.                               XP_Bool now);
  211.  
  212.  
  213. /* Resize the widget to accomodate "visibleCount" number of entries vertically
  214.    and the width of widest entry the actual widget should NOT change size, just
  215.    the size of the scrollable area under it */
  216. extern void BMFE_SyncDisplay(MWContext* context);
  217.  
  218.  
  219. /* measure the item and assign the width and height required to draw it into
  220.    the widget into width and height.  This is used only by BM_WidestEntry(); if
  221.    you don't need that call, you can just make this an empty stub. */
  222. extern void BMFE_MeasureEntry(MWContext* context, BM_Entry* entry,
  223.                               uint32* width, uint32* height);
  224.  
  225. /* Save the given bucket o' bits as the clipboard.  This same bucket needs to
  226.    be returned later if BMFE_GetClipContents() is called. */
  227. extern void BMFE_SetClipContents(MWContext* context, void* buffer,
  228.                                  int32 length);
  229.  
  230.  
  231. /* return the clipboard contents */
  232. extern void* BMFE_GetClipContents(MWContext* context, int32* length);
  233.  
  234.  
  235. /* Copy the selected items from a history window to the clipboard (as bookmarks) */
  236. extern char *BM_ClipCopyHistorySelection( void *pHistCsr, uint32 *pSelections, int iCount, int *pSize, XP_Bool bLongFormat );
  237.  
  238. /* Insert the block into the list */
  239. extern void BM_DropBlockL( MWContext *pContext, char *pData, BM_Entry *firstSelected );
  240.  
  241. /* Create the bookmarks property window.  If one already exists, just bring it
  242.    to the front.  This will always be immediately followed by a call to
  243.    BMFE_EditItem(). */
  244. extern void BMFE_OpenBookmarksWindow(MWContext* context);
  245.  
  246.  
  247. /* Edit the given item in the bookmarks property window.  If there is no
  248.    bookmarks property window currently, then the FE should ignore this call.
  249.    If the bookmarks property window is currently displaying some other entry,
  250.    then it should save any changes made to that entry (by calling BM_SetName,
  251.    etc.) before loading up this entry. */
  252. extern void BMFE_EditItem(MWContext* context, BM_Entry* entry);
  253.  
  254. /* The given entry is no longer valid (i.e., the user just deleted it).  So,
  255.    the given pointer is about to become invalid, and the FE should remove any
  256.    references to it it may have.  In particular, if it is the one being edited
  257.    in the bookmarks property window, then the FE should clear that window. */
  258. extern void BMFE_EntryGoingAway(MWContext* context, BM_Entry* entry);
  259.  
  260.  
  261. /* The user has requested to view the given url.  Show it to him in, using some
  262.    appropriate context.  Url may be targeted to a different window */
  263. extern void BMFE_GotoBookmark(MWContext* context,
  264.         const char* url, const char* target);
  265.                             
  266.  
  267. /* Create the find dialog, and fill it in as specified in the given
  268.    structure.  When the user hits the "Find" button in the dialog, call
  269.    BM_DoFindBookmark. */
  270. extern void* BMFE_OpenFindWindow(MWContext* context, BM_FindInfo* findInfo);
  271.                 
  272.  
  273. /* Make sure that the given entry is visible. */
  274. extern void BMFE_ScrollIntoView(MWContext* context, BM_Entry* entry);
  275.  
  276.  
  277. /* The list of bookmarks has changed somehow, so any "bookmarks" menu needs to
  278.    be recreated.  This should be a cheap call, just setting a flag in the FE so
  279.    that it knows to recreate the menu later (like, when the user tries to view
  280.    it).  Recreating it immediately would be bad, because this can get called
  281.    much more often than is reasonable. */
  282. extern void BMFE_BookmarkMenuInvalid(MWContext* context);
  283.  
  284.  
  285. /* We're in the process of doing a What's Changed operation.  The What's
  286.    Changed window should update to display the URL, the percentage (calculate
  287.    as done*100/total), and the total estimated time (given here as a
  288.    pre-formatted string).  The What's Changed window should end up looking
  289.    something like this:
  290.  
  291.              Checking <URL>... (<13> left)
  292.              {=====================    } (progress bar)
  293.  
  294.              Estimated time remaining: <2 hours 13 minutes>
  295.              (Remaining time depends on the sites selected and 
  296.              the network traffic).
  297.  
  298.  
  299.              [ Cancel ]
  300.  
  301.    It's up to the FE to notice the first time this is called and change its
  302.    window to display the info instead of the initial What's Changed screen.
  303.  
  304.    If the user ever hits Cancel (or does something equivilant, like destroys
  305.    the window), the FE must call BM_CancelWhatsChanged(). */
  306.  
  307. extern void BMFE_UpdateWhatsChanged(MWContext* context,
  308.                                     const char* url, /* If NULL, just display
  309.                                                         "Checking..." */
  310.                                     int32 done, int32 total,
  311.                                     const char* totaltime);
  312.  
  313.  
  314.  
  315. /* We've finished processing What's Changed.  The What's Changed window should
  316.    change to display the summary of what happened.   It should look something
  317.    like this:
  318.  
  319.              Done checking <157> Bookmarks. 
  320.              <134> documents were reached.
  321.              <27> documents have changed and are marked in blue.
  322.  
  323.              [ OK ]
  324.  
  325.    When the user clicks on the OK, the FE should just take down the window.
  326.    (It doesn't matter if the FE calls BM_CancelWhatsChanged(); it will be a
  327.    no-op in this situtation.) */
  328.  
  329. extern void BMFE_FinishedWhatsChanged(MWContext* context, int32 totalchecked,
  330.                                       int32 numreached, int32 numchanged);
  331.  
  332. #ifdef XP_WIN
  333. /* The current bookmarks file is about to change */
  334. extern void BMFE_ChangingBookmarksFile(void);
  335.  
  336. /* The current bookmarks file has been changed */
  337. extern void BMFE_ChangedBookmarksFile(void);
  338. #endif
  339.  
  340. #ifdef XP_UNIX
  341. /* Use these to know when to allow refresh */
  342. extern void BMFE_StartBatch(MWContext* context);
  343. extern void BMFE_EndBatch(MWContext* context);
  344. #endif
  345.  
  346. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  347.  
  348.  
  349.  
  350. /* Initialize a new bookmarks context.  (returns negative on failure) */
  351. extern int BM_InitializeBookmarksContext(MWContext* context);
  352.  
  353.  
  354. /* Prepare to destroy a bookmarks context.  Will save any changes that have
  355.    been made. */
  356. extern void BM_CleanupBookmarksContext(MWContext* context);
  357.  
  358.  
  359. /* Set some FE data to associate with a bookmarks context. */
  360. extern void BM_SetFEData(MWContext* context, void* data);
  361.  
  362. /* Get the FE data previously associated with a context. */
  363. extern void* BM_GetFEData(MWContext* context);
  364.  
  365.  
  366. /* Create a new url entry.  */
  367. extern BM_Entry* BM_NewUrl(const char* name, const char* address,
  368.                            const char* content_type, BM_Date last_visit);
  369.  
  370. /* Create a new header. */
  371. extern BM_Entry* BM_NewHeader(const char* name);
  372.  
  373.  
  374. /* Create a copy of an existing bookmark.  If the bookmark is a folder
  375.    it will also contain a copy of all of the bookmarks in the folder.*/
  376. extern BM_Entry* BM_CopyBookmark(MWContext* context, BM_Entry* original);
  377.  
  378. /* Frees an entry.  This should never be called unless you are sure the entry
  379.    has not been added to some header, and is not the object of some alias.  In
  380.    other words, be sure nothing could possibly have a pointer to this it.
  381.    If the object is a header, this will also free all of its descendents. */
  382. extern void BM_FreeEntry(MWContext* context, BM_Entry* entry);
  383.  
  384.  
  385. /* Get the type of this bookmark.  (Returns one of the BM_TYPE_* values.) */
  386. extern BM_Type BM_GetType(BM_Entry* entry);
  387.  
  388. extern char* BM_GetName(BM_Entry* entry);
  389.  
  390. extern char* BM_GetAddress(BM_Entry* entry);
  391. extern char* BM_GetTarget(BM_Entry* entry, XP_Bool recurse);
  392. extern char* BM_GetDescription(BM_Entry* entry);
  393.  
  394. extern char* BM_GetNickName(BM_Entry* entry); /* Only meaningful in address
  395.                                                  book. */
  396.  
  397. /* Get the full name and address of the given entry (which must be an
  398.    address book entry or header).  Result is returned in a newly allocated
  399.    string; free it with XP_FREE() when through. */
  400. extern char* BM_GetFullAddress(MWContext* context, BM_Entry* entry);
  401.  
  402. /* These return prettily formated info about the bookmark.  They each
  403.    return the result in a staticly allocated string, so if you call the
  404.    same function twice the results get stomped. */
  405. extern char* BM_PrettyLastVisitedDate(BM_Entry* entry);
  406. extern char* BM_PrettyAddedOnDate(BM_Entry* entry);
  407. extern char* BM_PrettyAliasCount(MWContext* context, BM_Entry* entry);
  408.  
  409.  
  410. /* Get the root node of a context. */
  411. extern BM_Entry* BM_GetRoot(MWContext* context);
  412.    
  413.  
  414. /* Given a node, return the first of its children (if any). */
  415. extern BM_Entry* BM_GetChildren(BM_Entry* entry);
  416.  
  417. /* Given a node, return the next node that has the same parent (if any). */
  418. extern BM_Entry* BM_GetNext(BM_Entry* entry);
  419.  
  420. /* Given a node, returns its parent (or NULL if this is the root) */
  421. extern BM_Entry* BM_GetParent(BM_Entry* entry);
  422.  
  423. /* Does this node have a sibling somewhere below it? */
  424. extern XP_Bool BM_HasNext(BM_Entry* entry);
  425.  
  426. /* Does this node have a sibling somewhere above it?  Note that there is *not*
  427.    an API to actually get that sibling, as this is not a simple call.  However,
  428.    determing the existance of such a child is easy, and that's what Windows
  429.    needs to paint its pipes. */
  430. extern XP_Bool BM_HasPrev(BM_Entry* entry);
  431.  
  432.  
  433.  
  434. /* Routines to change the name/address/description of an entry.  These routines
  435.    will take care of updating the display as necessary. */
  436. extern void BM_SetName(MWContext* context, BM_Entry* entry,
  437.                        const char* newName);
  438. extern void BM_SetAddress(MWContext* context, BM_Entry* entry,
  439.                           const char* newAddress);
  440. extern void BM_SetTarget(MWContext* context, BM_Entry* entry,
  441.                           const char* newTarget);
  442. extern void BM_SetDescription(MWContext* context, BM_Entry* entry,
  443.                               const char* newDesc);
  444.  
  445. /* Only meaningful in addressbook (on an address or header or alias to same) */
  446. extern XP_Bool BM_SetNickName(MWContext* context, BM_Entry* entry,
  447.                            const char* newName);
  448.  
  449. /* The user just hit "Cancel" on the properties window, which was editing
  450.    the given item.  This gives the bookmarks code a chance to delete the
  451.    item if it was just newly created. */
  452. extern void BM_CancelEdit(MWContext* context, BM_Entry* entry);
  453.  
  454.  
  455. /* fold or unfold the header according to "fold" and all its subfolders if
  456.     foldAll is TRUE */
  457. extern void BM_FoldHeader(MWContext* context, BM_Entry* entry, XP_Bool fold,
  458.                           XP_Bool refresh, XP_Bool foldAll);
  459.  
  460.                             
  461. /* clear all the selection flags, and cause a redisplay if refresh is set. */
  462. extern void BM_ClearAllSelection(MWContext* context, XP_Bool refresh);
  463.  
  464. /* Clear all the child selections of the passes header and redisplay if refresh
  465.    is set. */
  466. extern void BM_ClearAllChildSelection(MWContext* context, BM_Entry* at,
  467.                                       XP_Bool refresh);
  468.  
  469. /* Select everything. */
  470. extern void BM_SelectAll(MWContext* context, XP_Bool refresh);
  471.  
  472.  
  473. /* selects the item, call BMFE_Refresh on it if "refresh" and calls
  474.     BM_ClearSelection first if extend is FALSE */
  475. extern void BM_SelectItem(MWContext* context, BM_Entry* item, XP_Bool refresh,
  476.                           XP_Bool extend, XP_Bool select);
  477.  
  478. /* Adds a range of bookmarks to the current selection.  To be called by the FE
  479.    when the user Shift-Clicks in the window.  This will unselect everything and
  480.    then select a range of bookmarks, from the last bookmark that was selected
  481.    with BM_SelectItem to the one given here. */
  482. extern void BM_SelectRangeTo(MWContext* context, BM_Entry* item);
  483.  
  484. /* toggles the selected state of the item, call BMFE_Refresh on it if "refresh"
  485.     and calls BM_ClearSelection if extend is FALSE */
  486. extern void BM_ToggleItem(MWContext* context, BM_Entry* item, XP_Bool refresh,
  487.                           XP_Bool extend );
  488.  
  489. /* returns the first selected entry */
  490. extern BM_Entry* BM_FirstSelectedItem(MWContext* context);
  491.  
  492.  
  493. extern BM_Date BM_GetLastVisited(BM_Entry *);
  494. extern BM_Date BM_GetAdditionDate(BM_Entry *);
  495.  
  496. /* return the number of bookmarks */
  497. extern int32 BM_GetCount(MWContext* context);
  498.  
  499. /* return the number of visible bookmarks */
  500. extern int32 BM_GetVisibleCount(MWContext* context);
  501.  
  502. /* returns an integer index of the item in the list */
  503. extern int32 BM_GetIndex(MWContext* context, BM_Entry* item);
  504.  
  505. /* returns an integer index of the item in the list and does not pay attention
  506.    to the is_folded value */
  507. extern int32 BM_GetUnfoldedIndex(MWContext* context, BM_Entry* item);
  508.  
  509. /* returns the object associated with the index returned by BM_GetIndex() */
  510. extern BM_Entry* BM_AtIndex(MWContext* context, int32 index);
  511.  
  512. /* returns the object associated with the index returned by
  513.    BM_GetUnfoldedIndex() */
  514. extern BM_Entry* BM_AtUnfoldedIndex(MWContext* context, int32 index);
  515.  
  516.  
  517. /* returns an integer depth of the item in the list starting
  518.     at zero */
  519. extern int32 BM_GetDepth(MWContext* context, BM_Entry* item);
  520.  
  521.  
  522. /* Execute a find operation according to the data in the given structure.  This
  523.    will cause the appropriate entry to be selected and made visible. */
  524. extern void BM_DoFindBookmark(MWContext* context, BM_FindInfo* findInfo);
  525.  
  526. /* For addressbook only: find and return the entry (if any) for the e-mail
  527.    address within the given mailto: url. (used by libmsg) */
  528. extern BM_Entry* BM_FindAddress(MWContext* context, const char* mailtourl);
  529.  
  530.  
  531. /* For addressbook only: edit the entry for the e-mail address within the
  532.    given mailto: url, creating the entry if necessary.  (used by libmsg) */
  533. extern void BM_EditAddress(MWContext* context, const char* mailtourl);
  534.  
  535.  
  536. /* For addressbook only: if the given list of addresses includes a nickname
  537.    from the addresses, then return a new string with the addresses expanded.
  538.    If expandfull is True, then all mailing list entries are expanded too,
  539.    otherwise, mailing list entries are only expanded to include their name.
  540.    (used by libmsg). */
  541. extern char* BM_ExpandHeaderString(MWContext* context, const char* value,
  542.                                    XP_Bool expandfull);
  543.                                    
  544.  
  545. /* Checks every bookmark context for a url and updates the last accessed
  546.    time.  (For use by global history code; FE's probably don't need this.) */
  547. extern void BM_UpdateBookmarksTime(URL_Struct* URL_s, BM_Date cur_time);
  548.  
  549. /* returns TRUE if the second argument is a direct descendent of the first
  550.    argument, returns FALSE otherwise */
  551. extern XP_Bool BM_IsDescendent(MWContext* context, BM_Entry* parent,
  552.                                BM_Entry* possible_child);
  553.  
  554.  
  555. /* The front end can use this call to determine what the indentation depth is
  556.    needed to display all the icons in the bookmarks.  The XFE uses this to
  557.    dynamically resize the icon column. In true C style, the number returned is
  558.    actually one bigger than the biggest depth the FE will ever get. */
  559. extern int BM_GetMaxDepth(MWContext* context);
  560.  
  561.  
  562. /* This is called during a drag operation.  The user is dragging some bookmarks
  563.    and is currently pointing at the given line.  (If under is True, then the
  564.    user is really pointing between the given line and the next line.)  This
  565.    returns TRUE if the FE should draw a box around the given line, and FALSE if
  566.    it should underline it. */
  567. extern XP_Bool BM_IsDragEffectBox(MWContext* context, int line, XP_Bool under);
  568.  
  569.  
  570. /* Actually do a drop in a drag-n-drop reordering operation.  The arguments are
  571.    the same as BM_IsDragEffectBox(); the selected items will be moved. */
  572. extern void BM_DoDrop(MWContext* ctnx, int line, XP_Bool under);
  573.  
  574.  
  575.  
  576.  
  577. /* find and return the widest visible entry in the bookmarks tree.  This makes
  578.    sense only if your FE has defined a meaningful BMFE_MeasureEntry(). */
  579. extern BM_Entry* BM_WidestEntry(MWContext* context);
  580.  
  581.  
  582.  
  583. /* insert an item after another item in the bm if the insert_after item is NULL
  584.    or not found the item will be inserted at the end of the list */
  585. extern void BM_InsertItemAfter(MWContext* context, BM_Entry* insert_after,
  586.                                BM_Entry* insertee);
  587.  
  588. /* insert an item in a header if "insert_after" is a Header type, or after the
  589.    item if "insert after" is not a header type. if the insert_after item is
  590.    NULL or not found the item will be inserted at the end of the bm */
  591. extern void BM_InsertItemInHeaderOrAfterItem(MWContext* context,
  592.                                              BM_Entry* insert_after,
  593.                                              BM_Entry* insertee );
  594.  
  595. /* Cause the given item to be inserted at the end of the given header.  The
  596.    header passed in here is usually BM_GetAddHeader(). */
  597. extern void BM_AppendToHeader(MWContext* context, BM_Entry* header,
  598.                               BM_Entry* entry);
  599.  
  600. extern void BM_PrependChildToHeader(MWContext* context, BM_Entry* parent, BM_Entry* child);
  601.  
  602. /* Removes the given item from bookmarks without deleting it*/
  603. extern void BM_RemoveChildFromHeader(MWContext* context, BM_Entry* parent, BM_Entry* child);
  604.  
  605. /* Cause the given bookmark to be displayed in a browser window somewhere.
  606.    The given item must be an URL (BM_IsUrl must return TRUE). */
  607. extern void BM_GotoBookmark(MWContext* context, BM_Entry* item);
  608.  
  609.  
  610. /* Reads the hostlist from disk, what else?  Pass in the bm filename and a
  611.    relative URL which represents the original location of the html file.  If
  612.    you are reading the default bm you should pass in a file URL of the form
  613.    file://localhost/PATH */
  614. extern void BM_ReadBookmarksFromDisk(MWContext* context, const char* filename,
  615.                                      const char* relative_url);
  616.  
  617. /* saves the bm to a file.  If the given filename is NULL, then save it back to
  618.    where it was loaded from and only if changes have been made.  Returns
  619.    negative on failure. */
  620. extern int32 BM_SaveBookmarks(MWContext* context, const char* filename);
  621.  
  622.  
  623. /* Returns the filename that the bookmarks are saved in. */
  624. extern const char* BM_GetFileName(MWContext* context);
  625.  
  626. /* read in a new bookmarks file (esp for LI use). */
  627. extern void BM_Open_File(MWContext* context, char* newFile);
  628.  
  629. /* ability to set the modified to true or false (esp for LI use). */
  630. extern void BM_SetModified(MWContext* context, XP_Bool mod);
  631.  
  632. /* Whether the file will be written when Save is called. */
  633. extern XP_Bool BM_Modified(MWContext* context);
  634.  
  635. /* Convert a number of selections in a bm list into a block of memory that the
  636.    user can use for cut and paste operations */
  637. extern char* BM_ConvertSelectionsToBlock(MWContext* context,
  638.                                          XP_Bool bLongFormat,
  639.                                          int32* lTotalLen);
  640.  
  641. /* Take a block of memory and insert the bm items it represents into the
  642.    current bm */
  643. extern void BM_InsertBlockAt(MWContext* context, char* pOriginalBlock,
  644.                              BM_Entry* addTo, XP_Bool bLongFormat,
  645.                              int32 lTotalLen);
  646.  
  647.  
  648. /* select all aliases for an entry */
  649. extern void BM_SelectAliases(MWContext* context, BM_Entry* forEntry );
  650.  
  651.  
  652. /* Count how many aliases there are to the given entry. */
  653. extern int32 BM_CountAliases(MWContext* context, BM_Entry* forEntry);
  654.  
  655.  
  656. /* Make an alias for each of the currently selected entries. */
  657. extern void BM_MakeAliases(MWContext* context);
  658.  
  659.  
  660. /* Returns the real item that an alias points to.  The given entry must be an
  661.    alias (BM_IsAlias must return TRUE on it). */
  662. extern BM_Entry* BM_GetAliasOriginal(BM_Entry*);
  663.  
  664.  
  665.  
  666. /* Start a What's Changed operation.  Before calling this routine, it's up to
  667.    the FE to present a dialog like this when What's Changed starts:
  668.  
  669.                 Look for documents that have changed on:
  670.              (o) All bookmarks
  671.              ( ) Selected bookmarks 
  672.  
  673.              [ Start Checking ] [ Cancel ]
  674.  
  675.    Then the FE calls this routine when the user clicks Start Checking.  The FE
  676.    will immediately get called via BMFE_UpdateWhatsChanged(), and the FE should
  677.    change the dialog box's appearance to match. */
  678. extern int BM_StartWhatsChanged(MWContext* context,
  679.                                 XP_Bool do_only_selected);
  680.  
  681.  
  682. /* Cancel a running What's Changed operation. */
  683. extern int BM_CancelWhatsChanged(MWContext* context);
  684.  
  685.  
  686.  
  687. /* Returns whether the given command can be executed right now.  Should be
  688.    used to decide whether to disable a menu item for this command. */
  689. extern XP_Bool BM_FindCommandStatus(MWContext* context,
  690.                                     BM_CommandType command);
  691.  
  692. /* Execute the given command. */
  693. extern void BM_ObeyCommand(MWContext* context, BM_CommandType command );
  694.  
  695. /* Clean up the undo queue */
  696. void BM_ResetUndo(MWContext * context);
  697.  
  698. XP_END_PROTOS
  699.  
  700. #endif /* BMLIST_H */
  701.