sgallery.h File Reference

(r1785/r1267)

#include "sgtree.h"
#include "sgscan.h"
#include "dlgtypes.h"
#include "dialogop.h"

Go to the source code of this file.

Classes

class  SuperGallery
struct  SGOptsSortInfo
class  SGalleryOptionsDlg
class  SGallerySortDlg
class  SGallerySearchDlg

Defines

#define GSAFECLASS(TheClass)   (TheClass?TheClass:CC_RUNTIME_CLASS(DialogOp))
#define OPTOKEN_SGOPTIONSDLG   _T("GalleryOptionsDlg")
 A dialogue box allowing the user to set the gallery properties (display options) for its parent gallery.
#define OPTOKEN_SGSORTDLG   _T("GallerySortDlg")
 A dialogue box allowing the user to apply a sort mode to its parent SuperGallery DisplayTree.
#define OPTOKEN_SGSEARCHDLG   _T("GallerySearchDlg")
 A dialogue box allowing the user to search a gallery DisplayTree for items whose name or fullinfo text contains a given string.

Enumerations

enum  SGActionType {
  SGACTION_CREATE, SGACTION_APPLY, SGACTION_APPLYADJUST, SGACTION_REDEFINE,
  SGACTION_EDIT, SGACTION_DELETE, SGACTION_SETOPTIONS, SGACTION_SETSORTMODE,
  SGACTION_DISPLAYMODECHANGED, SGACTION_SETLINEPROPERTIES, SGACTION_ANIMATIONPROPERTIES, SGACTION_FRAMEPROPERTIES,
  SGACTION_UNDO
}
enum  SGMenuID { SGMENU_OVERITEM, SGMENU_OPTIONS }


Define Documentation

#define GSAFECLASS TheClass   )     (TheClass?TheClass:CC_RUNTIME_CLASS(DialogOp))
 

Definition at line 108 of file sgallery.h.

#define OPTOKEN_SGOPTIONSDLG   _T("GalleryOptionsDlg")
 

A dialogue box allowing the user to set the gallery properties (display options) for its parent gallery.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
9/3/95
See also:
SuperGallery; SGalleryOptionsDlg::InvokeDialog

Definition at line 728 of file sgallery.h.

#define OPTOKEN_SGSEARCHDLG   _T("GallerySearchDlg")
 

A dialogue box allowing the user to search a gallery DisplayTree for items whose name or fullinfo text contains a given string.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
12/3/95
See also:
SuperGallery; SGallerySearchDlg::InvokeDialog

Definition at line 855 of file sgallery.h.

#define OPTOKEN_SGSORTDLG   _T("GallerySortDlg")
 

A dialogue box allowing the user to apply a sort mode to its parent SuperGallery DisplayTree.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
19/9/95 (separated from opts dlg)
See also:
SuperGallery; SGallerySortDlg::InvokeDialog

Definition at line 788 of file sgallery.h.


Enumeration Type Documentation

enum SGActionType
 

Comment: MonoOn typedef enum { SGACTION_CREATE, SGACTION_APPLY, SGACTION_REDEFINE, SGACTION_EDIT, SGACTION_DELETE, SGACTION_SETOPTIONS, SGACTION_SETSORTMODE, SGACTION_DISPLAYMODECHANGED } SGActionType; MonoOff

This is used by the SuperGallery -> Derived class ApplyAction() upcall. This method recieves an action type, from the above list, and applies it to the gallery selection. The actions generally correspond to clicks on the standard SuperGallery action buttons.

MonoOn Action: What a conventional gallery would do:

CREATE Create a new item, usually copied from the selection APPLY Apply the selected item(s) to the document (select-click) APPLYADJUST Apply the selected item(s) to the document (adjust click) REDEFINE Redefine an item from selection (define by example) EDIT Redefine an item with an editor (e.g. colour editor) DELETE Delete the selected items SETOPTIONS Set options-dialogue values by calling the dialogue SETSORTMODE Set sort-dialogue values by calling the dialogue DISPLAYMODECHANGED Take appropriate action when the display mode changes SETLINEPROPERTIES Set line-properties-dialogue values by calling the dialogue MonoOff

See also:
SuperGallery::ApplyAction
Enumerator:
SGACTION_CREATE 
SGACTION_APPLY 
SGACTION_APPLYADJUST 
SGACTION_REDEFINE 
SGACTION_EDIT 
SGACTION_DELETE 
SGACTION_SETOPTIONS 
SGACTION_SETSORTMODE 
SGACTION_DISPLAYMODECHANGED 
SGACTION_SETLINEPROPERTIES 
SGACTION_ANIMATIONPROPERTIES 
SGACTION_FRAMEPROPERTIES 
SGACTION_UNDO 

Definition at line 166 of file sgallery.h.

00167 {
00168     SGACTION_CREATE,
00169     SGACTION_APPLY,
00170     SGACTION_APPLYADJUST,
00171     SGACTION_REDEFINE,
00172     SGACTION_EDIT,
00173     SGACTION_DELETE,
00174     SGACTION_SETOPTIONS,
00175     SGACTION_SETSORTMODE,
00176     SGACTION_DISPLAYMODECHANGED,
00177     SGACTION_SETLINEPROPERTIES,
00178 
00179     SGACTION_ANIMATIONPROPERTIES,
00180     SGACTION_FRAMEPROPERTIES,
00181 
00182     SGACTION_UNDO       // DEFUNCT - DO NOT USE! This will be removed when possible
00183 
00184 } SGActionType;

enum SGMenuID
 

Comment: MonoOn typedef enum { SGMENU_OVERITEM, SGMENU_OPTIONS } SGMenuID; MonoOff

An enum of this type is passed in when a request is made for a gallery to build a command menu. The current menu types are:

MonoOn SGMENU_OVERITEM Build a pop-up menu for the current selection SGMENU_OPTIONS Build a drop-down menu when the options button is clicked MonoOff

See also:
SuperGallery::BuildCommandMenu
Enumerator:
SGMENU_OVERITEM 
SGMENU_OPTIONS 

Definition at line 212 of file sgallery.h.

00213 {
00214     SGMENU_OVERITEM,
00215     SGMENU_OPTIONS
00216 } SGMenuID;


Generated on Sat Nov 10 03:49:20 2007 for Camelot by  doxygen 1.4.4