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 *const p_config = module_GetConfig (p_module, &confsize);
  90
  91     for (size_t i = 0; i < confsize; i++)
  92     {
  93         module_config_t *p_item = p_config + i;
  94
  95         const char *psz_help;
  96         QIcon icon;
  97         switch( p_item->i_type )
  98         {
  99         case CONFIG_CATEGORY:
 100             if( p_item->value.i == -1 ) break;
 101             data = new PrefsItemData();
 102             data->name = QString( qtr( config_CategoryNameGet
 103                                            ( p_item->value.i ) ) );
 104             psz_help = config_CategoryHelpGet( p_item->value.i );
 105             if( psz_help )
 106                 data->help = QString( qtr(psz_help) );
 107             else
 108                 data->help.clear();
 109             data->i_type = TYPE_CATEGORY;
 110             data->i_object_id = p_item->value.i;
 111
 112             switch( p_item->value.i )
 113             {
 114 #define CI(a,b) case a: icon = b##_icon;break
 115             CI( CAT_AUDIO, audio );
 116             CI( CAT_VIDEO, video );
 117             CI( CAT_INPUT, input );
 118             CI( CAT_SOUT, sout );
 119             CI( CAT_ADVANCED, advanced );
 120             CI( CAT_PLAYLIST, playlist );
 121             CI( CAT_INTERFACE, interface );
 122 #undef CI
 123             }
 124
 125             current_item = new QTreeWidgetItem();
 126             current_item->setText( 0, data->name );
 127             current_item->setIcon( 0 , icon );
 128             current_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 129             current_item->setData( 0, Qt::UserRole,
 130                                    qVariantFromValue( data ) );
 131             addTopLevelItem( current_item );
 132             break;
 133         case CONFIG_SUBCATEGORY:
 134             if( p_item->value.i == -1 ) break;
 135             if( data &&
 136                 ( p_item->value.i == SUBCAT_VIDEO_GENERAL ||
 137                   p_item->value.i == SUBCAT_ADVANCED_MISC ||
 138                   p_item->value.i == SUBCAT_INPUT_GENERAL ||
 139                   p_item->value.i == SUBCAT_INTERFACE_GENERAL ||
 140                   p_item->value.i == SUBCAT_SOUT_GENERAL||
 141                   p_item->value.i == SUBCAT_PLAYLIST_GENERAL||
 142                   p_item->value.i == SUBCAT_AUDIO_GENERAL ) )
 143             {
 144                 // Data still contains the correct thing
 145                 data->i_type = TYPE_CATSUBCAT;
 146                 data->i_subcat_id = p_item->value.i;
 147                 data->name = QString( qtr( config_CategoryNameGet(
 148                                             p_item->value.i )) );
 149                 psz_help = config_CategoryHelpGet( p_item->value.i );
 150                 if( psz_help )
 151                     data->help = QString( qtr(psz_help) );
 152                 else
 153                     data->help.clear();
 154                 current_item->setData( 0, Qt::UserRole,
 155                                        QVariant::fromValue( data ) );
 156                 continue;
 157             }
 158             data = new PrefsItemData();
 159             data->name = QString( qtr( config_CategoryNameGet(
 160                                                         p_item->value.i)) );
 161             psz_help = config_CategoryHelpGet( p_item->value.i );
 162             if( psz_help )
 163                 data->help = QString( qtr(psz_help) );
 164             else
 165                 data->help.clear();
 166             data->i_type = TYPE_SUBCATEGORY;
 167             data->i_object_id = p_item->value.i;
 168
 169             assert( current_item );
 170
 171             /* TODO : Choose the image */
 172             QTreeWidgetItem *subcat_item = new QTreeWidgetItem();
 173             subcat_item->setText( 0, data->name );
 174             //item->setIcon( 0 , XXX );
 175             subcat_item->setData( 0, Qt::UserRole,
 176                                   qVariantFromValue(data) );
 177             subcat_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 178             current_item->addChild( subcat_item );
 179             break;
 180         }
 181     }
 182     module_PutConfig (p_config);
 183
 184     /* Build the tree of plugins */
 185     for( int i_index = 0; i_index < p_list->i_count; i_index++ )
 186     {
 187         p_module = (module_t *)p_list->p_values[i_index].p_object;
 188
 189         // Main module excluded
 190         if( !strcmp( module_GetObjName( p_module ), "main" ) ) continue;
 191
 192         unsigned i_subcategory = 0, i_category = 0, confsize;
 193         bool b_options = false;
 194         module_config_t *const p_config = module_GetConfig (p_module, &confsize);
 195
 196         for (size_t i = 0; i < confsize; i++)
 197         {
 198             const module_config_t *p_item = p_config + i;
 199
 200             if( p_item->i_type == CONFIG_CATEGORY )
 201                 i_category = p_item->value.i;
 202             else if( p_item->i_type == CONFIG_SUBCATEGORY )
 203                 i_subcategory = p_item->value.i;
 204
 205             if( p_item->i_type & CONFIG_ITEM )
 206                 b_options = true;
 207
 208             if( b_options && i_category && i_subcategory )
 209                 break;
 210         }
 211         module_PutConfig (p_config);
 212         if( !b_options || i_category == 0 || i_subcategory == 0 ) continue;
 213
 214         // Locate the category item;
 215         QTreeWidgetItem *subcat_item = NULL;
 216         bool b_found = false;
 217         for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 218                                    i_cat_index++ )
 219         {
 220             QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 221             PrefsItemData *data = cat_item->data( 0, Qt::UserRole ).
 222                                              value<PrefsItemData *>();
 223             if( data->i_object_id == i_category )
 224             {
 225                 for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 226                          i_sc_index++ )
 227                 {
 228                     subcat_item = cat_item->child( i_sc_index );
 229                     PrefsItemData *sc_data = subcat_item->data(0, Qt::UserRole).
 230                                                 value<PrefsItemData *>();
 231                     if( sc_data && sc_data->i_object_id == i_subcategory )
 232                     {
 233                         b_found = true;
 234                         break;
 235                     }
 236                 }
 237                 if( !b_found )
 238                 {
 239                     subcat_item = cat_item;
 240                     b_found = true;
 241                 }
 242                 break;
 243             }
 244         }
 245         if( !b_found ) continue;
 246
 247         PrefsItemData *module_data = new PrefsItemData();
 248         module_data->i_type = TYPE_MODULE;
 249         module_data->psz_name = strdup( module_GetObjName( p_module ) );
 250         module_data->help.clear();
 251         // TODO image
 252         QTreeWidgetItem *module_item = new QTreeWidgetItem();
 253         module_item->setText( 0, qtr( module_GetName( p_module, VLC_FALSE ) ) );
 254         //item->setIcon( 0 , XXX );
 255         module_item->setData( 0, Qt::UserRole,
 256                               QVariant::fromValue( module_data) );
 257         module_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 258         subcat_item->addChild( module_item );
 259     }
 260
 261     /* We got everything, just sort a bit */
 262     sortItems( 0, Qt::AscendingOrder );
 263
 264     vlc_list_release( p_list );
 265 }
 266
 267 PrefsTree::~PrefsTree() {}
 268
 269 void PrefsTree::applyAll()
 270 {
 271     doAll( false );
 272 }
 273
 274 void PrefsTree::cleanAll()
 275 {
 276     doAll( true );
 277 }
 278
 279 void PrefsTree::doAll( bool doclean )
 280 {
 281     for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 282              i_cat_index++ )
 283     {
 284         QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 285         for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 286                  i_sc_index++ )
 287         {
 288             QTreeWidgetItem *sc_item = cat_item->child( i_sc_index );
 289             for( int i_module = 0 ; i_module < sc_item->childCount();
 290                      i_module++ )
 291             {
 292                 PrefsItemData *data = sc_item->child( i_module )->
 293                                data( 0, Qt::UserRole).value<PrefsItemData *>();
 294                 if( data->panel && doclean )
 295                 {
 296                     delete data->panel;
 297                     data->panel = NULL;
 298                 }
 299                 else if( data->panel )
 300                     data->panel->apply();
 301             }
 302             PrefsItemData *data = sc_item->data( 0, Qt::UserRole).
 303                                             value<PrefsItemData *>();
 304             if( data->panel && doclean )
 305             {
 306                 delete data->panel;
 307                 data->panel = NULL;
 308             }
 309             else if( data->panel )
 310                 data->panel->apply();
 311         }
 312         PrefsItemData *data = cat_item->data( 0, Qt::UserRole).
 313                                             value<PrefsItemData *>();
 314         if( data->panel && doclean )
 315         {
 316             delete data->panel;
 317             data->panel = NULL;
 318         }
 319         else if( data->panel )
 320             data->panel->apply();
 321     }
 322 }
 323
 324 /*********************************************************************
 325  * The Panel
 326  *********************************************************************/
 327 AdvPrefsPanel::AdvPrefsPanel( QWidget *_parent ) : QWidget( _parent )
 328 {}
 329
 330 AdvPrefsPanel::AdvPrefsPanel( intf_thread_t *_p_intf, QWidget *_parent,
 331                         PrefsItemData * data ) :
 332                         QWidget( _parent ), p_intf( _p_intf )
 333 {
 334     /* Find our module */
 335     module_t *p_module = NULL;
 336     if( data->i_type == TYPE_CATEGORY )
 337         return;
 338     else if( data->i_type == TYPE_MODULE )
 339         p_module = module_FindName( VLC_OBJECT(p_intf), data->psz_name );
 340     else
 341     {
 342         p_module = module_FindName( VLC_OBJECT(p_intf), "main" );
 343         assert( p_module );
 344     }
 345
 346     unsigned confsize;
 347     module_config_t *const p_config = module_GetConfig (p_module, &confsize),
 348                     *p_item = p_config,
 349                     *p_end = p_config + confsize;
 350
 351     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 352     {
 353         while (p_item < p_end)
 354         {
 355             if( p_item->i_type == CONFIG_SUBCATEGORY &&
 356                             ( data->i_type == TYPE_SUBCATEGORY &&
 357                               p_item->value.i == data->i_object_id ) ||
 358                             ( data->i_type == TYPE_CATSUBCAT &&
 359                               p_item->value.i == data->i_subcat_id ) )
 360                 break;
 361             p_item++;
 362         }
 363     }
 364
 365     /* Widgets now */
 366     global_layout = new QVBoxLayout();
 367     global_layout->setMargin( 2 );
 368     QString head;
 369     QString help;
 370
 371     help = QString( data->help );
 372
 373     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 374     {
 375         head = QString( data->name );
 376         p_item++; // Why that ?
 377     }
 378     else
 379     {
 380         const char *psz_help = module_GetHelp (p_module);
 381         head = QString( qtr( module_GetLongName( p_module ) ) );
 382         if( psz_help )
 383         {
 384             help.append( "\n" );
 385             help.append( qtr( psz_help ) );
 386         }
 387     }
 388
 389     QLabel *titleLabel = new QLabel( head );
 390     QFont titleFont = QApplication::font( static_cast<QWidget*>(0) );
 391     titleFont.setPointSize( titleFont.pointSize() + 6 );
 392     titleFont.setFamily( "Verdana" );
 393     titleLabel->setFont( titleFont );
 394
 395     // Title <hr>
 396     QFrame *title_line = new QFrame;
 397     title_line->setFrameShape(QFrame::HLine);
 398     title_line->setFrameShadow(QFrame::Sunken);
 399
 400     QLabel *helpLabel = new QLabel( help, this );
 401     helpLabel->setWordWrap( true );
 402
 403     global_layout->addWidget( titleLabel );
 404     global_layout->addWidget( title_line );
 405     global_layout->addWidget( helpLabel );
 406
 407     QGroupBox *box = NULL;
 408     QGridLayout *boxlayout = NULL;
 409
 410     QScrollArea *scroller= new QScrollArea;
 411     scroller->setFrameStyle( QFrame::NoFrame );
 412     QWidget *scrolled_area = new QWidget;
 413
 414     QGridLayout *layout = new QGridLayout();
 415     int i_line = 0, i_boxline = 0;
 416     bool has_hotkey = false;
 417
 418     if( p_item ) do
 419     {
 420         if( ( ( data->i_type == TYPE_SUBCATEGORY &&
 421                 p_item->value.i != data->i_object_id ) ||
 422               ( data->i_type == TYPE_CATSUBCAT  &&
 423                 p_item->value.i != data->i_subcat_id ) ) &&
 424             ( p_item->i_type == CONFIG_CATEGORY ||
 425               p_item->i_type == CONFIG_SUBCATEGORY ) )
 426             break;
 427         if( p_item->b_internal == VLC_TRUE ) continue;
 428
 429         if( p_item->i_type == CONFIG_SECTION )
 430         {
 431             if( box )
 432             {
 433                 box->setLayout( boxlayout );
 434                 layout->addWidget( box, i_line, 0, 1, 2 );
 435                 i_line++;
 436             }
 437             box = new QGroupBox( qtr(p_item->psz_text) );
 438             boxlayout = new QGridLayout();
 439         }
 440         /* Only one hotkey control */
 441         if( has_hotkey && p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 442                                          strstr( p_item->psz_name, "key-" ) )
 443             continue;
 444         if( p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 445                                             strstr( p_item->psz_name, "key-" ) )
 446             has_hotkey = true;
 447
 448         ConfigControl *control;
 449         if( ! box )
 450             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 451                                         p_item, NULL, layout, i_line );
 452         else
 453             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 454                                     p_item, NULL, boxlayout, i_boxline );
 455         if( !control )
 456             continue;
 457
 458         if( box ) i_boxline++;
 459         else i_line++;
 460         controls.append( control );
 461     }
 462     while( !( ( data->i_type == TYPE_SUBCATEGORY ||
 463                data->i_type == TYPE_CATSUBCAT ) &&
 464              ( p_item->i_type == CONFIG_CATEGORY ||
 465                p_item->i_type == CONFIG_SUBCATEGORY ) )
 466         && ( ++p_item < p_end ) );
 467
 468     if( box )
 469     {
 470         box->setLayout( boxlayout );
 471         layout->addWidget( box, i_line, 0, 1, 2 );
 472     }
 473
 474     module_Put( p_module );
 475
 476     scrolled_area->setSizePolicy( QSizePolicy::Preferred,QSizePolicy::Fixed );
 477     scrolled_area->setLayout( layout );
 478     scroller->setWidget( scrolled_area );
 479     scroller->setWidgetResizable( true );
 480     global_layout->addWidget( scroller );
 481     setLayout( global_layout );
 482 }
 483
 484 void AdvPrefsPanel::apply()
 485 {
 486     QList<ConfigControl *>::Iterator i;
 487     for( i = controls.begin() ; i != controls.end() ; i++ )
 488     {
 489         ConfigControl *c = qobject_cast<ConfigControl *>(*i);
 490         c->doApply( p_intf );
 491     }
 492 }
 493 void AdvPrefsPanel::clean()
 494 {}