.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxListItem 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxListItem \- 
.SH DESCRIPTION

  


   This class stores information about a wxListCtrl item or column.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/listctrl.h
.SH MEMBERS

  
.SS  wxListItem ()

     


      Constructor.
     
    
   
  
.SS void Clear ()

     


      Resets the item state to the default.
     
    
   
  
.SS wxListColumnFormat GetAlign ()

     


      Returns the alignment for this item. Can be one of wxLIST_FORMAT_LEFT,
      wxLIST_FORMAT_RIGHT or wxLIST_FORMAT_CENTRE.
     
    
   
  
.SS wxColour GetBackgroundColour ()

     


      Returns the background colour for this item.
     
    
   
  
.SS int GetColumn ()

     


      Returns the zero-based column; meaningful only in report mode.
     
    
   
  
.SS long GetData ()

     


      Returns client data associated with the control. Please note that client
      data is associated with the item and not with subitems.
     
    
   
  
.SS wxFont GetFont ()

     


      Returns the font used to display the item.
     
    
   
  
.SS long GetId ()

     


      Returns the zero-based item position.
     
    
   
  
.SS int GetImage ()

     


      Returns the zero-based index of the image associated with the item into
      the image list.
     
    
   
  
.SS long GetMask ()

     


      Returns a bit mask indicating which fields of the structure are valid; can
      be any combination of the following values:
     
     
      
       
        wxLIST_MASK_STATE
       
       
        
         GetState
        
         is valid.
       
      

       
      
       
        wxLIST_MASK_TEXT
       
       
        
         GetText
        
         is valid.
       
      

       
      
       
        wxLIST_MASK_IMAGE
       
       
        
         GetImage
        
         is valid.
       
      

       
      
       
        wxLIST_MASK_DATA
       
       
        
         GetData
        
         is valid.
       
      

       
      
       
        wxLIST_MASK_WIDTH
       
       
        
         GetWidth
        
         is valid.
       
      

       
      
       
        wxLIST_MASK_FORMAT
       
       
        
         GetFormat
        
         is valid.
       
      

     
    
   
  
.SS long GetState ()

     


      Returns a bit field representing the state of the item. Can be any
      combination of:
     
     
      
       
        wxLIST_STATE_DONTCARE
       
       
        Don't care what the state is. Win32 only.
       
      

       
      
       
        wxLIST_STATE_DROPHILITED
       
       
        The item is highlighted to receive a drop event. Win32 only.
       
      

       
      
       
        wxLIST_STATE_FOCUSED
       
       
        The item has the focus.
       
      

       
      
       
        wxLIST_STATE_SELECTED
       
       
        The item is selected.
       
      

       
      
       
        wxLIST_STATE_CUT
       
       
        The item is in the cut state. Win32 only.
       
      

     
    
   
  
.SS const wxString& GetText ()

     


      Returns the label/header text.
     
    
   
  
.SS wxColour GetTextColour ()

     


      Returns the text colour.
     
    
   
  
.SS int GetWidth ()

     


      Meaningful only for column headers in report mode. Returns the column
      width.
     
    
   
  
.SS void SetAlign (wxListColumnFormat align)

     


      Sets the alignment for the item. See also
      wxListItem::GetAlign
     
    
   
  
.SS void SetBackgroundColour (const wxColour& colBack)

     


      Sets the background colour for the item.
     
    
   
  
.SS void SetColumn (int col)

     


      Sets the zero-based column. Meaningful only in report mode.
     
    
   
  
.SS void SetData (long data)

.SS void SetData (void* data)

     


      Sets client data for the item. Please note that client data is associated
      with the item and not with subitems.
     
    
   
  
.SS void SetFont (const wxFont& font)

     


      Sets the font for the item.
     
    
   
  
.SS void SetId (long id)

     


      Sets the zero-based item position.
     
    
   
  
.SS void SetImage (int image)

     


      Sets the zero-based index of the image associated with the item into the
      image list.
     
    
   
  
.SS void SetMask (long mask)

     


      Sets the mask of valid fields. See
      wxListItem::GetMask
      .
     
    
   
  
.SS void SetState (long state)

     


      Sets the item state flags (note that the valid state flags are influenced
      by the value of the state mask, see
      wxListItem::SetStateMask
      ). See
      wxListItem::GetState
      for valid flag values.
     
    
   
  
.SS void SetStateMask (long stateMask)

     


      Sets the bitmask that is used to determine which of the state flags are to
      be set. See also
      wxListItem::SetState
      .
     
    
   
  
.SS void SetText (const wxString& text)

     


      Sets the text label for the item.
     
    
   
  
.SS void SetTextColour (const wxColour& colText)

     


      Sets the text colour for the item.
     
    
   
  
.SS void SetWidth (int width)

     


      Meaningful only for column headers in report mode. Sets the column width.
     
    
 
.SH "SEE ALSO"

  wxObject
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.