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     for (size_t i = 0; i < p_module->confsize; i++)
  89     {
  90         const module_config_t *p_item = p_module->p_config + i;
  91         const char *psz_help;
  92         QIcon icon;
  93         switch( p_item->i_type )
  94         {
  95         case CONFIG_CATEGORY:
  96             if( p_item->value.i == -1 ) break;
  97             data = new PrefsItemData();
  98             data->name = QString( qtr( config_CategoryNameGet
  99                                            ( p_item->value.i ) ) );
 100             psz_help = config_CategoryHelpGet( p_item->value.i );
 101             if( psz_help )
 102                 data->help = QString( qtr(psz_help) );
 103             else
 104                 data->help.clear();
 105             data->i_type = TYPE_CATEGORY;
 106             data->i_object_id = p_item->value.i;
 107
 108             switch( p_item->value.i )
 109             {
 110 #define CI(a,b) case a: icon = b##_icon;break
 111             CI( CAT_AUDIO, audio );
 112             CI( CAT_VIDEO, video );
 113             CI( CAT_INPUT, input );
 114             CI( CAT_SOUT, sout );
 115             CI( CAT_ADVANCED, advanced );
 116             CI( CAT_PLAYLIST, playlist );
 117             CI( CAT_INTERFACE, interface );
 118 #undef CI
 119             }
 120
 121             current_item = new QTreeWidgetItem();
 122             current_item->setText( 0, data->name );
 123             current_item->setIcon( 0 , icon );
 124             current_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 125             current_item->setData( 0, Qt::UserRole,
 126                                    qVariantFromValue( data ) );
 127             addTopLevelItem( current_item );
 128             break;
 129         case CONFIG_SUBCATEGORY:
 130             if( p_item->value.i == -1 ) break;
 131             if( data &&
 132                 ( p_item->value.i == SUBCAT_VIDEO_GENERAL ||
 133                   p_item->value.i == SUBCAT_ADVANCED_MISC ||
 134                   p_item->value.i == SUBCAT_INPUT_GENERAL ||
 135                   p_item->value.i == SUBCAT_INTERFACE_GENERAL ||
 136                   p_item->value.i == SUBCAT_SOUT_GENERAL||
 137                   p_item->value.i == SUBCAT_PLAYLIST_GENERAL||
 138                   p_item->value.i == SUBCAT_AUDIO_GENERAL ) )
 139             {
 140                 // Data still contains the correct thing
 141                 data->i_type = TYPE_CATSUBCAT;
 142                 data->i_subcat_id = p_item->value.i;
 143                 data->name = QString( qtr( config_CategoryNameGet(
 144                                             p_item->value.i )) );
 145                 psz_help = config_CategoryHelpGet( p_item->value.i );
 146                 if( psz_help )
 147                     data->help = QString( qtr(psz_help) );
 148                 else
 149                     data->help.clear();
 150                 current_item->setData( 0, Qt::UserRole,
 151                                        QVariant::fromValue( data ) );
 152                 continue;
 153             }
 154             data = new PrefsItemData();
 155             data->name = QString( qtr( config_CategoryNameGet(
 156                                                         p_item->value.i)) );
 157             psz_help = config_CategoryHelpGet( p_item->value.i );
 158             if( psz_help )
 159                 data->help = QString( qtr(psz_help) );
 160             else
 161                 data->help.clear();
 162             data->i_type = TYPE_SUBCATEGORY;
 163             data->i_object_id = p_item->value.i;
 164
 165             assert( current_item );
 166
 167             /* TODO : Choose the image */
 168             QTreeWidgetItem *subcat_item = new QTreeWidgetItem();
 169             subcat_item->setText( 0, data->name );
 170             //item->setIcon( 0 , XXX );
 171             subcat_item->setData( 0, Qt::UserRole,
 172                                   qVariantFromValue(data) );
 173             subcat_item->setSizeHint( 0, QSize( -1, ITEM_HEIGHT ) );
 174             current_item->addChild( subcat_item );
 175             break;
 176         }
 177     }
 178
 179     /* Build the tree of plugins */
 180     for( int i_index = 0; i_index < p_list->i_count; i_index++ )
 181     {
 182         p_module = (module_t *)p_list->p_values[i_index].p_object;
 183
 184         // Main module excluded
 185         if( !strcmp( module_GetObjName( p_module ), "main" ) ) continue;
 186
 187         /* Exclude submodules; they have no config options of their own */
 188         if( p_module->b_submodule ) continue;
 189
 190         unsigned i_subcategory = 0, i_category = 0;
 191         bool b_options = false;
 192
 193         for (size_t i = 0; i < p_module->confsize; i++)
 194         {
 195             const module_config_t *p_item = p_module->p_config + i;
 196
 197             if( p_item->i_type == CONFIG_CATEGORY )
 198                 i_category = p_item->value.i;
 199             else if( p_item->i_type == CONFIG_SUBCATEGORY )
 200                 i_subcategory = p_item->value.i;
 201
 202             if( p_item->i_type & CONFIG_ITEM )
 203                 b_options = true;
 204
 205             if( b_options && i_category && i_subcategory )
 206                 break;
 207         }
 208         if( !b_options || i_category == 0 || i_subcategory == 0 ) continue;
 209
 210         // Locate the category item;
 211         QTreeWidgetItem *subcat_item = NULL;
 212         bool b_found = false;
 213         for( int i_cat_index = 0 ; i_cat_index < topLevelItemCount();
 214                                    i_cat_index++ )
 215         {
 216             QTreeWidgetItem *cat_item = topLevelItem( i_cat_index );
 217             PrefsItemData *data = cat_item->data( 0, Qt::UserRole ).
 218                                              value<PrefsItemData *>();
 219             if( data->i_object_id == i_category )
 220             {
 221                 for( int i_sc_index = 0; i_sc_index < cat_item->childCount();
 222                          i_sc_index++ )
 223                 {
 224                     subcat_item = cat_item->child( i_sc_index );
 225                     PrefsItemData *sc_data = subcat_item->data(0, Qt::UserRole).
 226                                                 value<PrefsItemData *>();
 227                     if( sc_data && sc_data->i_object_id == i_subcategory )
 228                     {
 229                         b_found = true;
 230                         break;
 231                     }
 232                 }
 233                 if( !b_found )
 234                 {
 235                     subcat_item = cat_item;
 236                     b_found = true;
 237                 }
 238                 break;
 239             }
 240         }
 241         if( !b_found ) continue;
 242
 243         PrefsItemData *module_data = new PrefsItemData();
 244         module_data->b_submodule = p_module->b_submodule;
 245         module_data->i_type = TYPE_MODULE;
 246         module_data->psz_name = strdup( module_GetObjName( p_module ) );
 247         module_data->i_object_id = p_module->b_submodule ?
 248                          ((module_t *)p_module->p_parent)->i_object_id :
 249                          p_module->i_object_id;
 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_t *) vlc_object_get( p_intf, data->i_object_id );
 340     else
 341     {
 342         p_module = config_FindModule( VLC_OBJECT(p_intf), "main" );
 343         assert( p_module );
 344         vlc_object_yield( p_module );
 345     }
 346
 347     module_t *p_realmodule = p_module->b_submodule
 348             ? (module_t *)(p_module->p_parent)
 349             : p_module;
 350
 351     module_config_t *p_item = p_realmodule->p_config;
 352     module_config_t *p_end = p_item + p_realmodule->confsize;
 353
 354     if( data->i_type == TYPE_SUBCATEGORY || data->i_type ==  TYPE_CATSUBCAT )
 355     {
 356         while (p_item < p_end)
 357         {
 358             if( p_item->i_type == CONFIG_SUBCATEGORY &&
 359                             ( data->i_type == TYPE_SUBCATEGORY &&
 360                               p_item->value.i == data->i_object_id ) ||
 361                             ( data->i_type == TYPE_CATSUBCAT &&
 362                               p_item->value.i == data->i_subcat_id ) )
 363                 break;
 364             p_item++;
 365         }
 366     }
 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         head = QString( qtr( module_GetLongName( p_module ) ) );
 384         if( p_module->psz_help )
 385         {
 386             help.append( "\n" );
 387             help.append( qtr( module_GetHelp( p_module ) ) );
 388         }
 389     }
 390
 391     QLabel *titleLabel = new QLabel( head );
 392     QFont titleFont = QApplication::font( static_cast<QWidget*>(0) );
 393     titleFont.setPointSize( titleFont.pointSize() + 6 );
 394     titleFont.setFamily( "Verdana" );
 395     titleLabel->setFont( titleFont );
 396
 397     // Title <hr>
 398     QFrame *title_line = new QFrame;
 399     title_line->setFrameShape(QFrame::HLine);
 400     title_line->setFrameShadow(QFrame::Sunken);
 401
 402     QLabel *helpLabel = new QLabel( help, this );
 403     helpLabel->setWordWrap( true );
 404
 405     global_layout->addWidget( titleLabel );
 406     global_layout->addWidget( title_line );
 407     global_layout->addWidget( helpLabel );
 408
 409     QGroupBox *box = NULL;
 410     QGridLayout *boxlayout = NULL;
 411
 412     QScrollArea *scroller= new QScrollArea;
 413     scroller->setFrameStyle( QFrame::NoFrame );
 414     QWidget *scrolled_area = new QWidget;
 415
 416     QGridLayout *layout = new QGridLayout();
 417     int i_line = 0, i_boxline = 0;
 418     bool has_hotkey = false;
 419
 420     if( p_item ) do
 421     {
 422         if( ( ( data->i_type == TYPE_SUBCATEGORY &&
 423                 p_item->value.i != data->i_object_id ) ||
 424               ( data->i_type == TYPE_CATSUBCAT  &&
 425                 p_item->value.i != data->i_subcat_id ) ) &&
 426             ( p_item->i_type == CONFIG_CATEGORY ||
 427               p_item->i_type == CONFIG_SUBCATEGORY ) )
 428             break;
 429         if( p_item->b_internal == VLC_TRUE ) continue;
 430
 431         if( p_item->i_type == CONFIG_SECTION )
 432         {
 433             if( box )
 434             {
 435                 box->setLayout( boxlayout );
 436                 layout->addWidget( box, i_line, 0, 1, 2 );
 437                 i_line++;
 438             }
 439             box = new QGroupBox( qtr(p_item->psz_text) );
 440             boxlayout = new QGridLayout();
 441         }
 442         /* Only one hotkey control */
 443         if( has_hotkey && p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 444                                          strstr( p_item->psz_name, "key-" ) )
 445             continue;
 446         if( p_item->i_type & CONFIG_ITEM && p_item->psz_name &&
 447                                             strstr( p_item->psz_name, "key-" ) )
 448             has_hotkey = true;
 449
 450         ConfigControl *control;
 451         if( ! box )
 452             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 453                                         p_item, NULL, layout, i_line );
 454         else
 455             control = ConfigControl::createControl( VLC_OBJECT( p_intf ),
 456                                     p_item, NULL, boxlayout, i_boxline );
 457         if( !control )
 458             continue;
 459
 460         if( box ) i_boxline++;
 461         else i_line++;
 462         controls.append( control );
 463     }
 464     while( !( ( data->i_type == TYPE_SUBCATEGORY ||
 465                data->i_type == TYPE_CATSUBCAT ) &&
 466              ( p_item->i_type == CONFIG_CATEGORY ||
 467                p_item->i_type == CONFIG_SUBCATEGORY ) )
 468         && ( ++p_item < p_end ) );
 469
 470     if( box )
 471     {
 472         box->setLayout( boxlayout );
 473         layout->addWidget( box, i_line, 0, 1, 2 );
 474     }
 475
 476     vlc_object_release( p_module );
 477
 478     scrolled_area->setSizePolicy( QSizePolicy::Preferred,QSizePolicy::Fixed );
 479     scrolled_area->setLayout( layout );
 480     scroller->setWidget( scrolled_area );
 481     scroller->setWidgetResizable( true );
 482     global_layout->addWidget( scroller );
 483     setLayout( global_layout );
 484 }
 485
 486 void AdvPrefsPanel::apply()
 487 {
 488     QList<ConfigControl *>::Iterator i;
 489     for( i = controls.begin() ; i != controls.end() ; i++ )
 490     {
 491         ConfigControl *c = qobject_cast<ConfigControl *>(*i);
 492         c->doApply( p_intf );
 493     }
 494 }
 495 void AdvPrefsPanel::clean()
 496 {}