svx/source/dialog/checklbx.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: checklbx.cxx,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svx.hxx"
  33
  34 // include ---------------------------------------------------------------
  35 #include <tools/shl.hxx>
  36
  37 #define _SVX_CHECKLBX_CXX
  38
  39 #include <svx/checklbx.hxx>
  40 #include <svx/dialmgr.hxx>
  41
  42 #include <svx/dialogs.hrc>
  43
  44 // class SvxCheckListBox -------------------------------------------------
  45
  46 SvxCheckListBox::SvxCheckListBox( Window* pParent, WinBits nWinStyle ) :
  47
  48     SvTreeListBox( pParent, nWinStyle )
  49
  50 {
  51     Init_Impl();
  52 }
  53
  54 // -----------------------------------------------------------------------
  55
  56 SvxCheckListBox::SvxCheckListBox( Window* pParent, const ResId& rResId ) :
  57
  58     SvTreeListBox( pParent, rResId )
  59
  60 {
  61     Init_Impl();
  62 }
  63
  64 // -----------------------------------------------------------------------
  65
  66 SvxCheckListBox::SvxCheckListBox( Window* pParent, const ResId& rResId,
  67                                   const Image& rNormalStaticImage,
  68                                   const Image& /*TODO#i72485# rHighContrastStaticImage*/ ) :
  69
  70     SvTreeListBox( pParent, rResId )
  71
  72 {
  73     Init_Impl();
  74     pCheckButton->aBmps[SV_BMP_STATICIMAGE] = rNormalStaticImage;
  75 }
  76
  77 // -----------------------------------------------------------------------
  78
  79 SvxCheckListBox::~SvxCheckListBox()
  80 {
  81     delete pCheckButton;
  82 }
  83
  84 // -----------------------------------------------------------------------
  85
  86 void SvxCheckListBox::Init_Impl()
  87 {
  88     pCheckButton = new SvLBoxButtonData( this );
  89     EnableCheckButton( pCheckButton );
  90 }
  91
  92 // -----------------------------------------------------------------------
  93
  94 void SvxCheckListBox::InsertEntry( const String& rStr, USHORT nPos,
  95                                    void* pUserData,
  96                                    SvLBoxButtonKind eButtonKind )
  97 {
  98     SvTreeListBox::InsertEntry( rStr, NULL, FALSE, nPos, pUserData,
  99                                 eButtonKind );
 100 }
 101
 102 // -----------------------------------------------------------------------
 103
 104 void SvxCheckListBox::RemoveEntry( USHORT nPos )
 105 {
 106     if ( nPos < GetEntryCount() )
 107         SvTreeListBox::GetModel()->Remove( GetEntry( nPos ) );
 108 }
 109
 110 // -----------------------------------------------------------------------
 111
 112 void SvxCheckListBox::SelectEntryPos( USHORT nPos, BOOL bSelect )
 113 {
 114     if ( nPos < GetEntryCount() )
 115         Select( GetEntry( nPos ), bSelect );
 116 }
 117
 118 // -----------------------------------------------------------------------
 119
 120 USHORT SvxCheckListBox::GetSelectEntryPos() const
 121 {
 122     SvLBoxEntry* pEntry = GetCurEntry();
 123
 124     if ( pEntry )
 125         return (USHORT)GetModel()->GetAbsPos( pEntry );
 126     return LISTBOX_ENTRY_NOTFOUND;
 127 }
 128
 129 // -----------------------------------------------------------------------
 130
 131 String SvxCheckListBox::GetText( USHORT nPos ) const
 132 {
 133     SvLBoxEntry* pEntry = GetEntry( nPos );
 134
 135     if ( pEntry )
 136         return GetEntryText( pEntry );
 137     return String();
 138 }
 139
 140 // -----------------------------------------------------------------------
 141
 142 USHORT SvxCheckListBox::GetCheckedEntryCount() const
 143 {
 144     USHORT nCheckCount = 0;
 145     USHORT nCount = (USHORT)GetEntryCount();
 146
 147     for ( USHORT i = 0; i < nCount; ++i )
 148     {
 149         if ( IsChecked( i ) )
 150             nCheckCount++;
 151     }
 152     return nCheckCount;
 153 }
 154
 155 // -----------------------------------------------------------------------
 156
 157 void SvxCheckListBox::CheckEntryPos( USHORT nPos, BOOL bCheck )
 158 {
 159     if ( nPos < GetEntryCount() )
 160         SetCheckButtonState(
 161             GetEntry( nPos ), bCheck ? SvButtonState( SV_BUTTON_CHECKED ) :
 162                                        SvButtonState( SV_BUTTON_UNCHECKED ) );
 163 }
 164
 165 // -----------------------------------------------------------------------
 166
 167 BOOL SvxCheckListBox::IsChecked( USHORT nPos ) const
 168 {
 169     if ( nPos < GetEntryCount() )
 170         return (GetCheckButtonState( GetEntry( nPos ) ) == SV_BUTTON_CHECKED);
 171     else
 172         return FALSE;
 173 }
 174
 175 // -----------------------------------------------------------------------
 176
 177 void* SvxCheckListBox::SetEntryData     ( USHORT nPos, void* pNewData )
 178 {
 179     void* pOld = NULL;
 180
 181     if ( nPos < GetEntryCount() )
 182     {
 183         pOld = GetEntry( nPos )->GetUserData();
 184         GetEntry( nPos )->SetUserData( pNewData );
 185     }
 186     return pOld;
 187 }
 188
 189 // -----------------------------------------------------------------------
 190
 191 void* SvxCheckListBox::GetEntryData( USHORT nPos ) const
 192 {
 193     if ( nPos < GetEntryCount() )
 194         return GetEntry( nPos )->GetUserData();
 195     else
 196         return NULL;
 197 }
 198
 199 // -----------------------------------------------------------------------
 200
 201 void SvxCheckListBox::ToggleCheckButton( SvLBoxEntry* pEntry )
 202 {
 203     if ( pEntry )
 204     {
 205         if ( !IsSelected( pEntry ) )
 206             Select( pEntry );
 207         else
 208             CheckEntryPos( GetSelectEntryPos(), !IsChecked( GetSelectEntryPos() ) );
 209     }
 210 }
 211
 212 // -----------------------------------------------------------------------
 213
 214 void SvxCheckListBox::MouseButtonDown( const MouseEvent& rMEvt )
 215 {
 216     if ( rMEvt.IsLeft() )
 217     {
 218         Point aPnt = rMEvt.GetPosPixel();
 219         SvLBoxEntry* pEntry = GetEntry( aPnt );
 220
 221         if ( pEntry )
 222         {
 223             BOOL bCheck = ( GetCheckButtonState( pEntry ) == SV_BUTTON_CHECKED );
 224             SvLBoxItem* pItem = GetItem( pEntry, aPnt.X() );
 225
 226             if ( pItem && pItem->IsA() == SV_ITEM_ID_LBOXBUTTON )
 227             {
 228                 SvTreeListBox::MouseButtonDown( rMEvt );
 229                 Select( pEntry, TRUE );
 230                 return;
 231             }
 232             else
 233             {
 234                 ToggleCheckButton( pEntry );
 235                 SvTreeListBox::MouseButtonDown( rMEvt );
 236                 if ( bCheck != ( GetCheckButtonState( pEntry ) == SV_BUTTON_CHECKED ) )
 237                     CheckButtonHdl();
 238                 return;
 239             }
 240         }
 241     }
 242     SvTreeListBox::MouseButtonDown( rMEvt );
 243 }
 244
 245 // -----------------------------------------------------------------------
 246
 247 void SvxCheckListBox::KeyInput( const KeyEvent& rKEvt )
 248 {
 249     const KeyCode& rKey = rKEvt.GetKeyCode();
 250
 251     if ( rKey.GetCode() == KEY_RETURN || rKey.GetCode() == KEY_SPACE )
 252     {
 253         SvLBoxEntry* pEntry = GetCurEntry();
 254
 255         if ( pEntry )
 256         {
 257             BOOL bCheck = ( GetCheckButtonState( pEntry ) == SV_BUTTON_CHECKED );
 258             ToggleCheckButton( pEntry );
 259             if ( bCheck != ( GetCheckButtonState( pEntry ) == SV_BUTTON_CHECKED ) )
 260                 CheckButtonHdl();
 261         }
 262     }
 263     else if ( GetEntryCount() )
 264         SvTreeListBox::KeyInput( rKEvt );
 265 }
 266
 267 // -----------------------------------------------------------------------
 268
 269 SvLBoxEntry* SvxCheckListBox::InsertEntry( const XubString& rText, SvLBoxEntry* pParent, BOOL bChildsOnDemand, ULONG nPos, void* pUserData, SvLBoxButtonKind eButtonKind )
 270 {
 271     return SvTreeListBox::InsertEntry( rText, pParent, bChildsOnDemand, nPos, pUserData, eButtonKind );
 272 }
 273