Index

XContainerControl

XControl &rarrXContainerControl


public
  • columns
  • InsertColumn
  • QueryColumn
  • RemoveColumn
  • UpdateColumns
  • constructors/destructors
  • XContainerControl
  • ~XContainerControl
  • display
  • Arrange
  • HScroll
  • InvalidateObject
  • VScroll
  • info
  • QueryInfo
  • SetInfo
  • inserting/removing objects
  • AddObject
  • RemoveAll
  • RemoveObject
  • object settings
  • SetObjectEmphasis
  • searching
  • FindObject
  • QueryObject


  • Derrived

    : public XControl

    public

    columns

    InsertColumn

    Insert a column into a container. After you have added one or more columns, you must call Invalidate() so the columns are drawn.

    Definition

    BOOL InsertColumn ( XContainerColumn* column, XContainerColumn* insertBehind, BOOL redraw )

    BOOL InsertColumn ( XContainerColumn* column, XContainerColumn* insertBehind = NULL, BOOL redraw = FALSE )

    Parameters

    : XContainerColumn * theColumnToInsert This column should be inserted XContainerColumn * insertPosition The position to insert. Valid values are:

    CON_FIRST Insert as the first column. CON_LAST Insert as the last column. XContaineColumn* The column behind which the column should be inserted

    Returns

    BOOL

    BOOL success

    QueryColumn

    Query a column from a container.

    Definition

    XContainerColumn* QueryColumn ( XContainerColumn* col, SHORT option )

    Parameters

    : XContainerColumn * theColumnToSearch Relative position to begin search. In cases CMA_FIRST and CMA_LAST ignored. SHORT options Valid values are:

    CON_FIRST Get the first column. CON_LAST Get the last column. CON_NEXT Get the next relative to theColumnToSearch. CON_PREV Get the previous relative to theColumnToSearch.

    Returns

    XContainerColumn*

    XContainerControl * The found column.

    RemoveColumn

    Removes a column

    Definition

    BOOL RemoveColumn ( XContainerColumn* column, SHORT option )

    Parameters

    : XContainerColumn * theColumn The column to delete SHORT option How to delete. Valid values are:

    CON_FREE Destruct the column and free container related memory CON_INVALIDATE Redraw the container

    Returns

    BOOL

    BOOL success

    UpdateColumns

    Update columns in detail-view. If you have inserted, deleted or modified one ore more columns you must call UpdateColumns to make your changes visible.

    Definition

    void UpdateColumns ( void )

    Parameters

    : -

    Returns

    void

    -

    constructors/destructors

    XContainerControl

    Definition

    XContainerControl ( XWindow* owner, XRect* rec, USHORT id, ULONG style )

    XContainerControl ( HWND hwnd )

    XContainerControl ( XWindow* owner, XRect* rec, USHORT id = 0, ULONG style=WIN_VISIBLE¦WIN_BORDER )

    Parameters

    : XWindow * theOwner The owning window. XRect * rectangle Position and size. USHORT id The id of the window. Default is zero. ULONG style The style. valid values are:

    CON_AUTOPOSITION objects are arranged automaticaly CON_EXTENDSEL extended selection is enabled CON_MULTIPLESEL mutiple selection is enabled CON_READONLY directe diting is disabled CON_SINGLESEL only one object can be selected

    Returns

    -

    -

    ~XContainerControl

    Definition

    virtual ~XContainerControl ( )

    display

    Arrange

    Rearrange the object is the container

    Definition

    void Arrange ( void )

    Parameters

    : -

    Returns

    void

    -

    HScroll

    scrolls the container content horizontal

    Definition

    void HScroll ( LONG pix )

    Parameters

    : LONG pixels how much pixels to scroll

    Returns

    void

    -

    InvalidateObject

    invalidates one ore all objects Prameters: XContainerObject * theObject the object to invalidate (default is NULL) SHORT options options, valid values are: CON_ERASE erase the background CON_REPOSITION reposition CON_NOREPOSITION no reposition CON_TEXTCHANGED redraw the text (default is CON_REPOSITION, can be orïed)

    Definition

    void InvalidateObject ( XContainerObject* obj, SHORT option )

    void InvalidateObject ( XContainerObject* obj = NULL, SHORT option = CMA_REPOSITION )

    Returns

    void

    -

    VScroll

    scrolls the container content vertical

    Definition

    void VScroll ( LONG pix )

    Parameters

    : LONG pixels how much pixels to scroll

    Returns

    void

    -

    info

    QueryInfo

    querys information about the container.

    Definition

    void QueryInfo ( XContainerInfo* info )

    void QueryInfo ( XContainerInfo* )

    Parameters

    : XContainerInfo * the information buffer to hold the information

    Returns

    void

    -

    SetInfo

    Set information how to display the container.

    Definition

    void SetInfo ( XContainerInfo* info )

    void SetInfo ( XContainerInfo* )

    Parameters

    : XContainerInfo * the information See the description of XContainerInfo

    Returns

    void

    -

    inserting/removing objects

    AddObject

    add an object to the container

    Definition

    BOOL AddObject ( XContainerObject* object, XContainerObject* parentObject )

    BOOL AddObject ( XContainerObject* objectList, XContainerObject* parentObject=NULL )

    Parameters

    : XContainerObject * theObject object to add XContainerObject * parentObject parent of the object (for tree-view) (default is NULL)

    Returns

    BOOL

    BOOL success

    RemoveAll

    Remove all objects from a container

    Definition

    void RemoveAll ( BOOL destroyRecords )

    void RemoveAll ( BOOL destroyObjects = TRUE )

    Parameters

    : BOOL destroyObjects the destructors of the objects are called and memory ascociated with the container is freed.

    Returns

    void

    -

    RemoveObject

    removes an object from the container

    Definition

    BOOL RemoveObject ( XContainerObject* obj, BOOL destroyObject, BOOL redraw )

    BOOL RemoveObject ( XContainerObject* , BOOL destroyObject = TRUE, BOOL redraw = FALSE )

    Parameters

    : XContainerObject * theObject the object to remove BOOL destryObject if TRUE the destructor of theObject is called if FALSE it exist (usefull if an object is member of multiple container-controls) (default is TRUE) BOOL redraw redraw the container (defeult is TRUE)

    Returns

    BOOL

    BOOL success

    object settings

    SetObjectEmphasis

    sets the emphasis of an object so displaying the objects icon is changed

    Definition

    void SetObjectEmphasis ( XContainerObject* obj, SHORT emph, BOOL enableEmph )

    void SetObjectEmphasis ( XContainerObject* obj, SHORT emph, BOOL enableEmph=TRUE )

    Parameters

    : XContainerObject * theObject object to change SHORT emphasis the needed emphasis, valid values are: CON_CURSORED the object has the cursored CON_DISABLED the object is disabled CON_INUSE the objects icon is displayed open CON_PICKED the objects icon is displayed dragged CON_SELECTED the object is selected CON_SOURCE the object get source-emphasis (cab be orïed) BOOL enable enable/disable emphasis

    Returns

    void

    -

    searching

    FindObject

    Get an object from the container with relative positions

    Definition

    XContainerObject* FindObject ( XContainerObject* startObject, SHORT select )

    XContainerObject* FindObject ( XContainerObject* startObject = NULL, SHORT select=CON_FIRST )

    Parameters

    : XContainerObject * startObject search relative to this object (default is NULL) SHORT select serach setings, valid values are: CON_FIRST get the first object of the container CON_FIRSTCHILD get the first child of startObject CON_LAST get the last object of the container CON_LASTCHILD get the last child of startObject CON_NEXT get the next object relative to startObject CON_PARENT get the parent of startObject CON_PREV get the previous object relative to startObject default is CON_FIRST

    Returns

    XContainerObject*

    XContainerObject * pointer to the found object (NULL if nothing is found)

    QueryObject

    Get an object from the container by querying the objects emphasis

    Definition

    XContainerObject* QueryObject ( XContainerObject* startObject, SHORT filter )

    XContainerObject* QueryObject ( XContainerObject* startObject = NULL, SHORT filter= CON_SELECTED )

    Parameters

    : XContainerObject * startObject search relative to this object (default is NULL) SHORT filter the emphasis to search CON_CURSORED the object has the cursored CON_DISABLED the object is disabled CON_INUSE the objects icon is displayed open CON_PICKED the objects icon is displayed dragged CON_SELECTED the object is selected CON_SOURCE the object get source-emphasis (default is CON_SELECTED, can be orïed)

    Returns

    XContainerObject*

    XContainerObject * pointer to the found object (NULL if nothing is found)


    Created by AutoDoc, (C) 1996 by Jens von Pilgrim