util/src/TclTk/tk8.6.12/generic/ttk/ttkManager.h

   1 /*
   2  * Copyright (c) 2005, Joe English.  Freely redistributable.
   3  *
   4  * Geometry manager utilities.
   5  */
   6
   7 #ifndef _TTKMANAGER
   8 #define _TTKMANAGER
   9
  10 #include "ttkTheme.h"
  11
  12 typedef struct TtkManager_ Ttk_Manager;
  13
  14 /*
  15  * Geometry manager specification record:
  16  *
  17  * RequestedSize computes the requested size of the container window.
  18  *
  19  * PlaceSlaves sets the position and size of all managed content windows
  20  * by calling Ttk_PlaceContent().
  21  *
  22  * SlaveRemoved() is called immediately before a content window is removed.
  23  * NB: the associated content window may have been destroyed when this
  24  * routine is called.
  25  *
  26  * SlaveRequest() is called when a content window requests a size change.
  27  * It should return 1 if the request should propagate, 0 otherwise.
  28  */
  29 typedef struct {                        /* Manager hooks */
  30     Tk_GeomMgr tkGeomMgr;               /* "real" Tk Geometry Manager */
  31
  32     int  (*RequestedSize)(void *managerData, int *widthPtr, int *heightPtr);
  33     void (*PlaceSlaves)(void *managerData);
  34     int  (*SlaveRequest)(void *managerData, int index, int w, int h);
  35     void (*SlaveRemoved)(void *managerData, int index);
  36 } Ttk_ManagerSpec;
  37
  38 /*
  39  * Default implementations for Tk_GeomMgr hooks:
  40  */
  41 #define Ttk_LostContentProc Ttk_LostSlaveProc
  42 MODULE_SCOPE void Ttk_GeometryRequestProc(ClientData, Tk_Window window);
  43 MODULE_SCOPE void Ttk_LostContentProc(ClientData, Tk_Window window);
  44
  45 /*
  46  * Public API:
  47  */
  48 MODULE_SCOPE Ttk_Manager *Ttk_CreateManager(
  49         Ttk_ManagerSpec *, void *managerData, Tk_Window window);
  50 MODULE_SCOPE void Ttk_DeleteManager(Ttk_Manager *);
  51
  52 #define Ttk_InsertContent  Ttk_InsertSlave
  53 MODULE_SCOPE void Ttk_InsertContent(
  54     Ttk_Manager *, int position, Tk_Window, void *data);
  55
  56 #define Ttk_ForgetContent Ttk_ForgetSlave
  57 MODULE_SCOPE void Ttk_ForgetContent(Ttk_Manager *, int index);
  58
  59 #define Ttk_ReorderContent Ttk_ReorderSlave
  60 MODULE_SCOPE void Ttk_ReorderContent(Ttk_Manager *, int fromIndex, int toIndex);
  61     /* Rearrange content window positions */
  62
  63 #define Ttk_PlaceContent Ttk_PlaceSlave
  64 MODULE_SCOPE void Ttk_PlaceContent(
  65     Ttk_Manager *, int index, int x, int y, int width, int height);
  66     /* Position and map the content window */
  67
  68 #define Ttk_UnmapContent Ttk_UnmapSlave
  69 MODULE_SCOPE void Ttk_UnmapContent(Ttk_Manager *, int index);
  70     /* Unmap the content window */
  71
  72 MODULE_SCOPE void Ttk_ManagerSizeChanged(Ttk_Manager *);
  73 MODULE_SCOPE void Ttk_ManagerLayoutChanged(Ttk_Manager *);
  74     /* Notify manager that size (resp. layout) needs to be recomputed */
  75
  76 /* Utilities:
  77  */
  78 #define Ttk_ContentIndex Ttk_SlaveIndex
  79 MODULE_SCOPE int Ttk_ContentIndex(Ttk_Manager *, Tk_Window);
  80     /* Returns: index in content array of specified window, -1 if not found */
  81
  82 #define Ttk_GetContentIndexFromObj Ttk_GetSlaveIndexFromObj
  83 MODULE_SCOPE int Ttk_GetContentIndexFromObj(
  84     Tcl_Interp *, Ttk_Manager *, Tcl_Obj *, int *indexPtr);
  85
  86 /* Accessor functions:
  87  */
  88 #define Ttk_NumberContent Ttk_NumberSlaves
  89 MODULE_SCOPE int Ttk_NumberContent(Ttk_Manager *);
  90     /* Returns: number of managed content windows */
  91
  92 #define Ttk_ContentData Ttk_SlaveData
  93 MODULE_SCOPE void *Ttk_ContentData(Ttk_Manager *, int index);
  94     /* Returns: client data associated with content window */
  95
  96 #define Ttk_ContentWindow Ttk_SlaveWindow
  97 MODULE_SCOPE Tk_Window Ttk_ContentWindow(Ttk_Manager *, int index);
  98     /* Returns: content window */
  99
 100 MODULE_SCOPE int Ttk_Maintainable(Tcl_Interp *, Tk_Window content, Tk_Window container);
 101     /* Returns: 1 if container can manage content; 0 otherwise leaving error msg */
 102
 103 #endif /* _TTKMANAGER */