git.sesse.net Git - vlc/blob - modules/gui/qt4/components/complete_preferences.cpp

   1 /*****************************************************************************
   2  * preferences.cpp : "Normal preferences"
   3  ****************************************************************************
   4  * Copyright (C) 2006-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include <QApplication>
  25 #include <QLabel>
  26 #include <QTreeWidget>
  27 #include <QTreeWidgetItem>
  28 #include <QVariant>
  29 #include <QString>
  30 #include <QFont>
  31 #include <QGroupBox>
  32 #include <QScrollArea>
  33 #include <QVBoxLayout>
  34 #include <QHBoxLayout>
  35 #include <QGridLayout>
  36 #include <QHeaderView>
  37 #include <QPalette>
  38 #include <QColor>
  39
  40 #include "components/complete_preferences.hpp"
  41 #include "components/preferences_widgets.hpp"
  42
  43 #include <vlc_config_cat.h>
  44 #include <vlc_intf_strings.h>
  45 #include <assert.h>
  46
  47 #define ITEM_HEIGHT 25
  48
  49 /*********************************************************************
  50  * The Tree
  51  *********************************************************************/
  52 PrefsTree::PrefsTree( intf_thread_t *_p_intf, QWidget *_parent ) :
  53                             QTreeWidget( _parent ), p_intf( _p_intf )
  54 {
  55     setColumnCount( 1 );
  56     setAlternatingRowColors( true );
  57     header()->hide();
  58     setIconSize( QSize( ITEM_HEIGHT,ITEM_HEIGHT ) );
  59     setTextElideMode( Qt::ElideNone );
  60     setHorizontalScrollBarPolicy ( Qt::ScrollBarAlwaysOn );
  61
  62 #define BI( a,b) QIcon a##_icon = QIcon( QPixmap( b ))
  63     BI( audio, ":/pixmaps/vlc_advprefs_audio.png" );
  64     BI( video, ":/pixmaps/vlc_advprefs_video.png" );
  65     BI( input, ":/pixmaps/vlc_advprefs_codec.png" );
  66     BI( sout, ":/pixmaps/vlc_advprefs_sout.png" );
  67     BI( advanced, ":/pixmaps/vlc_advprefs_extended.png" );
  68     BI( playlist, ":/pixmaps/vlc_advprefs_playlist.png" );
  69     BI( interface, ":/pixmaps/vlc_advprefs_intf.png" );
  70 #undef BI
  71
  72     /* Build the tree for the main module */
  73     const module_t *p_module = NULL;
  74     vlc_list_t *p_list = vlc_list_find( p_intf, VLC_OBJECT_MODULE,
  75                                         FIND_ANYWHERE );
  76     if( !p_list ) return;
  77     for( unsigned i = 0; p_module == NULL; i++ )
  78     {
  79         assert (i < (unsigned)p_list->i_count);
  80
  81         const module_t *p_main = (module_t *)p_list->p_values[i].p_object;
  82         if( strcmp( module_GetObjName( p_main ), "main" ) == 0 )
  83             p_module = p_main;
  84     }
  85
  86     PrefsItemData *data = NULL;
  87     QTreeWidgetItem *current_item = NULL;
  88     unsigned confsize;
  89     module_config_t *p_config;
  90
  91     p_config = module_GetConfig (p_module, &confsize);
  92
  93     for (size_t i = 0; i < confsize; i++)
  94     {
  95         module_config_t *p_item = p_config + i;
  96
  97         const char *psz_help;
  98         QIcon icon;
  99         switch( p_item->i_type )
 100         {
 101         case CONFIG_CATEGORY:
 102             if( p_item->value.i == -1 ) break;
 103             data = new PrefsItemData();
 104             data->name = QString( qtr( config_CategoryNameGet
 105                                            ( p_item->value.i ) ) );
 106             psz_help = config_CategoryHelpGet( p_item->value.i );
 107             if( psz_help )
 108                 data->help = QString( qtr(psz_help) );
 109             else
 110                 data->help.clear();
 111             data->i_type = TYPE_CATEGORY;
 112             data->i_object_id = p_item->value.i;
 113
 114             switch( p_item->value.i )
 115             {
 116 #define CI(a,b) case a: icon = b##_icon;break
 117             CI( CAT_AUDIO, audio );
 118             CI( CAT_VIDEO, video );
 119             CI( CAT_INPUT, input );
 120             CI( CAT_SOUT, sout );
 121             CI( CAT_ADVANCED, advanced );
 122             CI( CAT_PLAYLIST, playlist );
 123             CI( CAT_INTERFACE, interface );
 124 #undef CI
 125             }
 126
 127             current_item = new QTreeWidgetItem();
 128             current_item->setText( 0, data->name );
 129             current_item->setIcon( 0 , icon );
 130             current_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 131             current_item->setData( 0, Qt::UserRole,
 132                                    qVariantFromValue( data ) );
 133             addTopLevelItem( current_item );
 134             break;
 135         case CONFIG_SUBCATEGORY:
 136             if( p_item->value.i == -1 ) break;
 137             if( data &&
 138                 ( p_item->value.i == SUBCAT_VIDEO_GENERAL ||
 139                   p_item->value.i == SUBCAT_ADVANCED_MISC ||
 140                   p_item->value.i == SUBCAT_INPUT_GENERAL ||
 141                   p_item->value.i == SUBCAT_INTERFACE_GENERAL ||
 142                   p_item->value.i == SUBCAT_SOUT_GENERAL||
 143                   p_item->value.i == SUBCAT_PLAYLIST_GENERAL||
 144                   p_item->value.i == SUBCAT_AUDIO_GENERAL ) )
 145             {
 146                 // Data still contains the correct thing
 147                 data->i_type = TYPE_CATSUBCAT;
 148                 data->i_subcat_id = p_item->value.i;
 149                 data->name = QString( qtr( config_CategoryNameGet(
 150                                             p_item->value.i )) );
 151                 psz_help = config_CategoryHelpGet( p_item->value.i );
 152                 if( psz_help )
 153                     data->help = QString( qtr(psz_help) );
 154                 else
 155                     data->help.clear();
 156                 current_item->setData( 0, Qt::UserRole,
 157                                        QVariant::fromValue( data ) );
 158                 continue;
 159             }
 160             data = new PrefsItemData();
 161             data->name = QString( qtr( config_CategoryNameGet(
 162                                                         p_item->value.i)) );
 163             psz_help = config_CategoryHelpGet( p_item->value.i );
 164             if( psz_help )
 165                 data->help = QString( qtr(psz_help) );
 166             else
 167                 data->help.clear();
 168             data->i_type = TYPE_SUBCATEGORY;
 169             data->i_object_id = p_item->value.i;
 170
 171             assert( current_item );
 172
 173             /* TODO : Choose the image */
 174             QTreeWidgetItem *subcat_item = new QTreeWidgetItem();
 175             subcat_item->setText( 0, data->name );
 176             //item->setIcon( 0 , XXX );
 177             subcat_item->setData( 0, Qt::UserRole,
 178                                   qVariantFromValue(data) );
 179             subcat_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 180             current_item->addChild( subcat_item );
 181             break;
 182         }
 183     }
 184     module_PutConfig (p_config);
 185
 186     /* Build the tree of plugins */
 187     for( int i_index = 0; i_index < p_list->i_count; i_index++ )
 188     {
 189         p_module = (module_t *)p_list->p_values[i_index].p_object;
 190
 191         // Main module excluded
 192         if( !strcmp( module_GetObjName( p_module ), "main" ) ) continue;
 193
 194         unsigned i_subcategory = 0, i_category = 0, confsize;
 195         bool b_options = false;
 196         module_config_t *p_config = module_GetConfig (p_module, &confsize);
 197
 198         for (size_t i = 0; i < confsize; i++)
 199         {
 200             const module_config_t *p_item = p_config + i;
 201
 202             if( p_item->i_type == CONFIG_CATEGORY )
 203                 i_category = p_item->value.i;
 204             else if( p_item->i_type == CONFIG_SUBCATEGORY )
 205                 i_subcategory = p_item->value.i;
 206
 207             if( p_item->i_type & CONFIG_ITEM )
 208                 b_options = true;
 209
 210             if( b_options && i_category && i_subcategory )
 211                 break;
 212         }
 213         module_PutConfig (p_config);
 214         if( !b_options || i_category == 0 || i_subcategory == 0 ) continue;
 215
 216         // Locate the category item;
 217         QTreeWidgetItem *subcat_item = NULL;
 218         bool b_found = false;
 219         for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 220                                    i_cat_index++ )
 221         {
 222             QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 223             PrefsItemData *data = cat_item->data( 0, Qt::UserRole ).
 224                                              value<PrefsItemData *>();
 225             if( data->i_object_id == i_category )
 226             {
 227                 for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 228                          i_sc_index++ )
 229                 {
 230                     subcat_item = cat_item->child( i_sc_index );
 231                     PrefsItemData *sc_data = subcat_item->data(0, Qt::UserRole).
 232                                                 value<PrefsItemData *>();
 233                     if( sc_data && sc_data->i_object_id == i_subcategory )
 234                     {
 235                         b_found = true;
 236                         break;
 237                     }
 238                 }
 239                 if( !b_found )
 240                 {
 241                     subcat_item = cat_item;
 242                     b_found = true;
 243                 }
 244                 break;
 245             }
 246         }
 247         if( !b_found ) continue;
 248
 249         PrefsItemData *module_data = new PrefsItemData();
 250         module_data->i_type = TYPE_MODULE;
 251         module_data->psz_name = strdup( module_GetObjName( p_module ) );
 252         module_data->help.clear();
 253         // TODO image
 254         QTreeWidgetItem *module_item = new QTreeWidgetItem();
 255         module_item->setText( 0, qtr( module_GetName( p_module, VLC_FALSE ) ) );
 256         //item->setIcon( 0 , XXX );
 257         module_item->setData( 0, Qt::UserRole,
 258                               QVariant::fromValue( module_data) );
 259         module_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 260         subcat_item->addChild( module_item );
 261     }
 262
 263     /* We got everything, just sort a bit */
 264     sortItems( 0, Qt::AscendingOrder );
 265
 266     vlc_list_release( p_list );
 267 }
 268
 269 PrefsTree::~PrefsTree() {}
 270
 271 void PrefsTree::applyAll()
 272 {
 273     doAll( false );
 274 }
 275
 276 void PrefsTree::cleanAll()
 277 {
 278     doAll( true );
 279 }
 280
 281 void PrefsTree::doAll( bool doclean )
 282 {
 283     for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 284              i_cat_index++ )
 285     {
 286         QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 287         for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 288                  i_sc_index++ )
 289         {
 290             QTreeWidgetItem *sc_item = cat_item->child( i_sc_index );
 291             for( int i_module = 0 ; i_module < sc_item->childCount();
 292                      i_module++ )
 293             {
 294                 PrefsItemData *data = sc_item->child( i_module )->
 295                                data( 0, Qt::UserRole).value<PrefsItemData *>();
 296                 if( data->panel && doclean )
 297                 {
 298                     delete data->panel;
 299                     data->panel = NULL;
 300                 }
 301                 else if( data->panel )
 302                     data->panel->apply();
 303             }
 304             PrefsItemData *data = sc_item->data( 0, Qt::UserRole).
 305                                             value<PrefsItemData *>();
 306             if( data->panel && doclean )
 307             {
 308                 delete data->panel;
 309                 data->panel = NULL;
 310             }
 311             else if( data->panel )
 312                 data->panel->apply();
 313         }
 314         PrefsItemData *data = cat_item->data( 0, Qt::UserRole).
 315                                             value<PrefsItemData *>();
 316         if( data->panel && doclean )
 317         {
 318             delete data->panel;
 319             data->panel = NULL;
 320         }
 321         else if( data->panel )
 322             data->panel->apply();
 323     }
 324 }
 325
 326 /*********************************************************************
 327  * The Panel
 328  *********************************************************************/
 329 AdvPrefsPanel::AdvPrefsPanel( QWidget *_parent ) : QWidget( _parent )
 330 {}
 331
 332 AdvPrefsPanel::AdvPrefsPanel( intf_thread_t *_p_intf, QWidget *_parent,
 333                         PrefsItemData * data ) :
 334                         QWidget( _parent ), p_intf( _p_intf )
 335 {
 336     /* Find our module */
 337     module_t *p_module = NULL;
 338     if( data->i_type == TYPE_CATEGORY )
 339         return;
 340     else if( data->i_type == TYPE_MODULE )
 341         p_module = module_FindName( VLC_OBJECT(p_intf), data->psz_name );
 342     else
 343     {
 344         p_module = module_FindName( VLC_OBJECT(p_intf), "main" );
 345         assert( p_module );
 346     }
 347
 348     unsigned confsize;
 349     module_config_t *p_config = module_GetConfig (p_module, &confsize),
 350                     *p_item = p_config,
 351                     *p_end = p_config + confsize;
 352
 353     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 354     {
 355         while (p_item < p_end)
 356         {
 357             if( p_item->i_type == CONFIG_SUBCATEGORY &&
 358                             ( data->i_type == TYPE_SUBCATEGORY &&
 359                               p_item->value.i == data->i_object_id ) ||
 360                             ( data->i_type == TYPE_CATSUBCAT &&
 361                               p_item->value.i == data->i_subcat_id ) )
 362                 break;
 363             p_item++;
 364         }
 365     }
 366     module_PutConfig (p_config);
 367
 368     /* Widgets now */
 369     global_layout = new QVBoxLayout();
 370     global_layout->setMargin( 2 );
 371     QString head;
 372     QString help;
 373
 374     help = QString( data->help );
 375
 376     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 377     {
 378         head = QString( data->name );
 379         p_item++; // Why that ?
 380     }
 381     else
 382     {
 383         const char *psz_help = module_GetHelp (p_module);
 384         head = QString( qtr( module_GetLongName( p_module ) ) );
 385         if( psz_help )
 386         {
 387             help.append( "\n" );
 388             help.append( qtr( psz_help ) );
 389         }
 390     }
 391
 392     QLabel *titleLabel = new QLabel( head );
 393     QFont titleFont = QApplication::font( static_cast<QWidget*>(0) );
 394     titleFont.setPointSize( titleFont.pointSize() + 6 );
 395     titleFont.setFamily( "Verdana" );
 396     titleLabel->setFont( titleFont );
 397
 398     // Title <hr>
 399     QFrame *title_line = new QFrame;
 400     title_line->setFrameShape(QFrame::HLine);
 401     title_line->setFrameShadow(QFrame::Sunken);
 402
 403     QLabel *helpLabel = new QLabel( help, this );
 404     helpLabel->setWordWrap( true );
 405
 406     global_layout->addWidget( titleLabel );
 407     global_layout->addWidget( title_line );
 408     global_layout->addWidget( helpLabel );
 409
 410     QGroupBox *box = NULL;
 411     QGridLayout *boxlayout = NULL;
 412
 413     QScrollArea *scroller= new QScrollArea;
 414     scroller->setFrameStyle( QFrame::NoFrame );
 415     QWidget *scrolled_area = new QWidget;
 416
 417     QGridLayout *layout = new QGridLayout();
 418     int i_line = 0, i_boxline = 0;
 419     bool has_hotkey = false;
 420
 421     if( p_item ) do
 422     {
 423         if( ( ( data->i_type == TYPE_SUBCATEGORY &&
 424                 p_item->value.i != data->i_object_id ) ||
 425               ( data->i_type == TYPE_CATSUBCAT  &&
 426                 p_item->value.i != data->i_subcat_id ) ) &&
 427             ( p_item->i_type == CONFIG_CATEGORY ||
 428               p_item->i_type == CONFIG_SUBCATEGORY ) )
 429             break;
 430         if( p_item->b_internal == VLC_TRUE ) continue;
 431
 432         if( p_item->i_type == CONFIG_SECTION )
 433         {
 434             if( box )
 435             {
 436                 box->setLayout( boxlayout );
 437                 layout->addWidget( box, i_line, 0, 1, 2 );
 438                 i_line++;
 439             }
 440             box = new QGroupBox( qtr(p_item->psz_text) );
 441             boxlayout = new QGridLayout();
 442         }
 443         /* Only one hotkey control */
 444         if( has_hotkey && p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 445                                          strstr( p_item->psz_name, "key-" ) )
 446             continue;
 447         if( p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 448                                             strstr( p_item->psz_name, "key-" ) )
 449             has_hotkey = true;
 450
 451         ConfigControl *control;
 452         if( ! box )
 453             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 454                                         p_item, NULL, layout, i_line );
 455         else
 456             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 457                                     p_item, NULL, boxlayout, i_boxline );
 458         if( !control )
 459             continue;
 460
 461         if( box ) i_boxline++;
 462         else i_line++;
 463         controls.append( control );
 464     }
 465     while( !( ( data->i_type == TYPE_SUBCATEGORY ||
 466                data->i_type == TYPE_CATSUBCAT ) &&
 467              ( p_item->i_type == CONFIG_CATEGORY ||
 468                p_item->i_type == CONFIG_SUBCATEGORY ) )
 469         && ( ++p_item < p_end ) );
 470
 471     if( box )
 472     {
 473         box->setLayout( boxlayout );
 474         layout->addWidget( box, i_line, 0, 1, 2 );
 475     }
 476
 477     module_Put( p_module );
 478
 479     scrolled_area->setSizePolicy( QSizePolicy::Preferred,QSizePolicy::Fixed );
 480     scrolled_area->setLayout( layout );
 481     scroller->setWidget( scrolled_area );
 482     scroller->setWidgetResizable( true );
 483     global_layout->addWidget( scroller );
 484     setLayout( global_layout );
 485 }
 486
 487 void AdvPrefsPanel::apply()
 488 {
 489     QList<ConfigControl *>::Iterator i;
 490     for( i = controls.begin() ; i != controls.end() ; i++ )
 491     {
 492         ConfigControl *c = qobject_cast<ConfigControl *>(*i);
 493         c->doApply( p_intf );
 494     }
 495 }
 496 void AdvPrefsPanel::clean()
 497 {}